@matheusbsbs / matheus-bagliano / commits / ee4e22554f

run-command: document use_shell option

It's unclear how run-command's use_shell option should impact the arguments fed to a command. Plausibly it could mean that we glue all of the arguments together into a string to pass to the shell, in which case that opens the question of whether the caller needs to quote them. But in fact we don't implement it that way (and even if we did, we'd probably auto-quote the arguments as part of the glue step). And we must not receive quoted arguments, because we might actually optimize out the shell entirely (i.e., the caller does not even know if a shell will be involved in the end or not). Since this ambiguity may have been the cause of a recent bug, let's document the option a bit. Signed-off-by: Jeff King <peff@peff.net> Reviewed-by: Taylor Blau <me@ttaylorr.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jeff King committed Jan 22, 2021 at 16:03 UTC ee4e22554f3d1f4a9ab53dc7719434a9031a300a
1 file changed +8 -1
run-command.h
+8 -1
@@ -126,8 +126,15 @@ struct child_process {
126 */
127 unsigned silent_exec_failure:1;
128
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 + */
135 unsigned use_shell:1;
136 +
137 + unsigned stdout_to_stderr:1;
138 unsigned clean_on_exit:1;
139 unsigned wait_after_clean:1;
140 void (*clean_on_exit_handler)(struct child_process *process);