Allow environment variables to be unset in the processes started by run_command

[thirdparty/git.git] / run-command.h

diff --git a/run-command.h b/run-command.h
index af1e0bf1789f13cd14e189b1042e8e1cbe2c2dca..7958eb1e0b7a927019460e06d7a01622eddf81df 100644 (file)
--- a/run-command.h
+++ b/run-command.h
@@ -35,6 +35,11 @@ int run_command(struct child_process *);
 #define RUN_COMMAND_STDOUT_TO_STDERR 4
 int run_command_v_opt(const char **argv, int opt);
 int run_command_v_opt_cd(const char **argv, int opt, const char *dir);
+
+/*
+ * env (the environment) is to be formatted like environ: "VAR=VALUE".
+ * To unset an environment variable use just "VAR".
+ */
 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
 
 #endif