summaryrefslogtreecommitdiff
path: root/Documentation/config
diff options
context:
space:
mode:
authorLibravatar Josh Steadmon <steadmon@google.com>2020-03-20 14:06:15 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2020-03-23 13:14:53 -0700
commit3d3adaad914441a6e7b916eb8dfd5ae638aab068 (patch)
tree19b976864a32cd6a80e8c2c35339db0a39c0aeba /Documentation/config
parentMerge https://github.com/prati0100/git-gui (diff)
downloadtgif-3d3adaad914441a6e7b916eb8dfd5ae638aab068.tar.xz
trace2: teach Git to log environment variables
Via trace2, Git can already log interesting config parameters (see the trace2_cmd_list_config() function). However, this can grant an incomplete picture because many config parameters also allow overrides via environment variables. To allow for more complete logs, we add a new trace2_cmd_list_env_vars() function and supporting implementation, modeled after the pre-existing config param logging implementation. Signed-off-by: Josh Steadmon <steadmon@google.com> Acked-by: Jeff Hostetler <jeffhost@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config')
-rw-r--r--Documentation/config/trace2.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/config/trace2.txt b/Documentation/config/trace2.txt
index 4ce0b9a6d1..01d3afd8a8 100644
--- a/Documentation/config/trace2.txt
+++ b/Documentation/config/trace2.txt
@@ -48,6 +48,15 @@ trace2.configParams::
May be overridden by the `GIT_TRACE2_CONFIG_PARAMS` environment
variable. Unset by default.
+trace2.envVars::
+ A comma-separated list of "important" environment variables that should
+ be recorded in the trace2 output. For example,
+ `GIT_HTTP_USER_AGENT,GIT_CONFIG` would cause the trace2 output to
+ contain events listing the overrides for HTTP user agent and the
+ location of the Git configuration file (assuming any are set). May be
+ overriden by the `GIT_TRACE2_ENV_VARS` environment variable. Unset by
+ default.
+
trace2.destinationDebug::
Boolean. When true Git will print error messages when a
trace target destination cannot be opened for writing.