From 29fda24dd11e90583f3ea9ff2f90ee9acacd7792 Mon Sep 17 00:00:00 2001 From: Ævar Arnfjörð Bjarmason Date: Thu, 2 Jun 2022 11:09:50 +0200 Subject: run-command API: rename "env_array" to "env" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Start following-up on the rename mentioned in c7c4bdeccf3 (run-command API: remove "env" member, always use "env_array", 2021-11-25) of "env_array" to "env". The "env_array" name was picked in 19a583dc39e (run-command: add env_array, an optional argv_array for env, 2014-10-19) because "env" was taken. Let's not forever keep the oddity of "*_array" for this "struct strvec", but not for its "args" sibling. This commit is almost entirely made with a coccinelle rule[1]. The only manual change here is in run-command.h to rename the struct member itself and to change "env_array" to "env" in the CHILD_PROCESS_INIT initializer. The rest of this is all a result of applying [1]: * make contrib/coccinelle/run_command.cocci.patch * patch -p1 env_array + E->env I've avoided changing any comments and derived variable names here, that will all be done in the next commit. Signed-off-by: Ævar Arnfjörð Bjarmason Signed-off-by: Junio C Hamano --- run-command.c | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'run-command.c') diff --git a/run-command.c b/run-command.c index a8501e38ce..5f7ea713f0 100644 --- a/run-command.c +++ b/run-command.c @@ -20,7 +20,7 @@ void child_process_init(struct child_process *child) void child_process_clear(struct child_process *child) { strvec_clear(&child->args); - strvec_clear(&child->env_array); + strvec_clear(&child->env); } struct child_to_clean { @@ -646,7 +646,7 @@ static void trace_run_command(const struct child_process *cp) sq_quote_buf_pretty(&buf, cp->dir); strbuf_addch(&buf, ';'); } - trace_add_env(&buf, cp->env_array.v); + trace_add_env(&buf, cp->env.v); if (cp->git_cmd) strbuf_addstr(&buf, " git"); sq_quote_argv_pretty(&buf, cp->args.v); @@ -751,7 +751,7 @@ fail_pipe: set_cloexec(null_fd); } - childenv = prep_childenv(cmd->env_array.v); + childenv = prep_childenv(cmd->env.v); atfork_prepare(&as); /* @@ -914,8 +914,9 @@ end_of_spawn: else if (cmd->use_shell) cmd->args.v = prepare_shell_cmd(&nargv, sargv); - cmd->pid = mingw_spawnvpe(cmd->args.v[0], cmd->args.v, (char**) cmd->env_array.v, - cmd->dir, fhin, fhout, fherr); + cmd->pid = mingw_spawnvpe(cmd->args.v[0], cmd->args.v, + (char**) cmd->env.v, + cmd->dir, fhin, fhout, fherr); failed_errno = errno; if (cmd->pid < 0 && (!cmd->silent_exec_failure || errno != ENOENT)) error_errno("cannot spawn %s", cmd->args.v[0]); @@ -1031,7 +1032,7 @@ int run_command_v_opt_cd_env_tr2(const char **argv, int opt, const char *dir, cmd.close_object_store = opt & RUN_CLOSE_OBJECT_STORE ? 1 : 0; cmd.dir = dir; if (env) - strvec_pushv(&cmd.env_array, (const char **)env); + strvec_pushv(&cmd.env, (const char **)env); cmd.trace2_child_class = tr2_class; return run_command(&cmd); } -- cgit v1.3 From b3193252c4278e9039fbb896a35f84abc1fb5aac Mon Sep 17 00:00:00 2001 From: Ævar Arnfjörð Bjarmason Date: Thu, 2 Jun 2022 11:09:51 +0200 Subject: run-command API users: use "env" not "env_array" in comments & names MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Follow-up on a preceding commit which changed all references to the "env_array" when referring to the "struct child_process" member. These changes are all unnecessary for the compiler, but help the code's human readers. All the comments that referred to "env_array" have now been updated, as well as function names and variables that had "env_array" in their name, they now refer to "env". In addition the "out" name for the submodule.h prototype was inconsistent with the function definition's use of "env_array" in submodule.c. Both of them use "env" now. Signed-off-by: Ævar Arnfjörð Bjarmason Signed-off-by: Junio C Hamano --- builtin/submodule--helper.c | 2 +- run-command.c | 6 +++--- run-command.h | 10 +++++----- sequencer.c | 6 +++--- submodule.h | 4 ++-- 5 files changed, 14 insertions(+), 14 deletions(-) (limited to 'run-command.c') diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c index d89184fbf4..0f1b82fd87 100644 --- a/builtin/submodule--helper.c +++ b/builtin/submodule--helper.c @@ -513,7 +513,7 @@ static void runcommand_in_submodule_cb(const struct cache_entry *list_item, * on windows. And since environment variables are * case-insensitive in windows, it interferes with the * existing PATH variable. Hence, to avoid that, we expose - * path via the args strvec and not via env_array. + * path via the args strvec and not via env. */ sq_quote_buf(&sb, path); strvec_pushf(&cp.args, "path=%s; %s", diff --git a/run-command.c b/run-command.c index 5f7ea713f0..789eaa5975 100644 --- a/run-command.c +++ b/run-command.c @@ -1816,16 +1816,16 @@ int run_auto_maintenance(int quiet) return run_command(&maint); } -void prepare_other_repo_env(struct strvec *env_array, const char *new_git_dir) +void prepare_other_repo_env(struct strvec *env, const char *new_git_dir) { const char * const *var; for (var = local_repo_env; *var; var++) { if (strcmp(*var, CONFIG_DATA_ENVIRONMENT) && strcmp(*var, CONFIG_COUNT_ENVIRONMENT)) - strvec_push(env_array, *var); + strvec_push(env, *var); } - strvec_pushf(env_array, "%s=%s", GIT_DIR_ENVIRONMENT, new_git_dir); + strvec_pushf(env, "%s=%s", GIT_DIR_ENVIRONMENT, new_git_dir); } enum start_bg_result start_bg_command(struct child_process *cmd, diff --git a/run-command.h b/run-command.h index 89e1bda0c9..bb43ccf646 100644 --- a/run-command.h +++ b/run-command.h @@ -58,7 +58,7 @@ struct child_process { struct strvec args; /** - * Like .args the .env_array is a `struct strvec'. + * Like .args the .env is a `struct strvec'. * * To modify the environment of the sub-process, specify an array of * environment settings. Each string in the array manipulates the @@ -70,7 +70,7 @@ struct child_process { * - If the string does not contain '=', it names an environment * variable that will be removed from the child process's environment. * - * The memory in .env_array will be cleaned up automatically during + * The memory in .env will be cleaned up automatically during * `finish_command` (or during `start_command` when it is unsuccessful). */ struct strvec env; @@ -480,14 +480,14 @@ int run_processes_parallel_tr2(int n, get_next_task_fn, start_failure_fn, const char *tr2_category, const char *tr2_label); /** - * Convenience function which prepares env_array for a command to be run in a - * new repo. This adds all GIT_* environment variables to env_array with the + * Convenience function which prepares env for a command to be run in a + * new repo. This adds all GIT_* environment variables to env with the * exception of GIT_CONFIG_PARAMETERS and GIT_CONFIG_COUNT (which cause the * corresponding environment variables to be unset in the subprocess) and adds * an environment variable pointing to new_git_dir. See local_repo_env in * cache.h for more information. */ -void prepare_other_repo_env(struct strvec *env_array, const char *new_git_dir); +void prepare_other_repo_env(struct strvec *env, const char *new_git_dir); /** * Possible return values for start_bg_command(). diff --git a/sequencer.c b/sequencer.c index 3d0331b768..79e14b51a2 100644 --- a/sequencer.c +++ b/sequencer.c @@ -919,7 +919,7 @@ static char *get_author(const char *message) return NULL; } -static const char *author_date_from_env_array(const struct strvec *env) +static const char *author_date_from_env(const struct strvec *env) { int i; const char *date; @@ -1011,7 +1011,7 @@ static int run_git_commit(const char *defmsg, strvec_pushf(&cmd.env, "GIT_COMMITTER_DATE=%s", opts->ignore_date ? "" : - author_date_from_env_array(&cmd.env)); + author_date_from_env(&cmd.env)); if (opts->ignore_date) strvec_push(&cmd.env, "GIT_AUTHOR_DATE="); @@ -3923,7 +3923,7 @@ static int do_merge(struct repository *r, strvec_pushf(&cmd.env, "GIT_COMMITTER_DATE=%s", opts->ignore_date ? "" : - author_date_from_env_array(&cmd.env)); + author_date_from_env(&cmd.env)); if (opts->ignore_date) strvec_push(&cmd.env, "GIT_AUTHOR_DATE="); diff --git a/submodule.h b/submodule.h index 40c1445237..2ac7a04e72 100644 --- a/submodule.h +++ b/submodule.h @@ -158,11 +158,11 @@ int submodule_move_head(const char *path, void submodule_unset_core_worktree(const struct submodule *sub); /* - * Prepare the "env_array" parameter of a "struct child_process" for executing + * Prepare the "env" parameter of a "struct child_process" for executing * a submodule by clearing any repo-specific environment variables, but * retaining any config in the environment. */ -void prepare_submodule_repo_env(struct strvec *out); +void prepare_submodule_repo_env(struct strvec *env); #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0) void absorb_git_dir_into_superproject(const char *path, -- cgit v1.3