Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-17 22:18:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fix documentation for system_env BIF

Browse source
This commit is contained in:
Daniel Thayer 2012-06-01 13:12:55 -05:00
parent 3b2ac75e91
commit 19e3f2ee56
3 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/bro.bif
View file

@ -466,17 +466,18 @@ function system%(str: string%): int
##
## str: The command to execute.
##
## env: A :bro:type:`set` or :bro:type:`table` with the environment variables
## in the form of key-value pairs (where the value is optional).
## env: A :bro:type:`table` with the environment variables in the form
## of key-value pairs. Each specified environment variable name
## will be automatically prepended with ``BRO_ARG_``.
##
## Returns: The return value from the OS ``system`` function.
##
## .. bro:see:: system str_shell_escape piped_exec
function system_env%(str: string, env: any%): int
function system_env%(str: string, env: table_string_of_string%): int
%{
if ( env->Type()->Tag() != TYPE_TABLE )
{
builtin_error("system_env() requires a table/set argument");
builtin_error("system_env() requires a table argument");
return new Val(-1, TYPE_INT);
}