Skip to content

Commit 22f2bce

Browse files
committed
Merge branch 'jk/run-command-use-shell-doc'
The .use_shell flag in struct child_process that is passed to run_command() API has been clarified with a bit more documentation. * jk/run-command-use-shell-doc: run-command: document use_shell option
2 parents 973e20b + ee4e225 commit 22f2bce

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

run-command.h

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,15 @@ struct child_process {
126126
*/
127127
unsigned silent_exec_failure:1;
128128

129-
unsigned stdout_to_stderr:1;
129+
/**
130+
* Run the command from argv[0] using a shell (but note that we may
131+
* still optimize out the shell call if the command contains no
132+
* metacharacters). Note that further arguments to the command in
133+
* argv[1], etc, do not need to be shell-quoted.
134+
*/
130135
unsigned use_shell:1;
136+
137+
unsigned stdout_to_stderr:1;
131138
unsigned clean_on_exit:1;
132139
unsigned wait_after_clean:1;
133140
void (*clean_on_exit_handler)(struct child_process *process);

0 commit comments

Comments
 (0)