run-command API users: use "env" not "env_array" in comments & names

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 <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ævar Arnfjörð Bjarmason
2022-06-02 11:09:51 +02:00
committed by Junio C Hamano
parent 29fda24dd1
commit b3193252c4
5 changed files with 14 additions and 14 deletions

View File

@@ -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().