summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2020-04-22 20:42:43 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-04-22 20:42:44 (GMT)
commit810dc6481ad7c1e1a6aacebfeaed308778c6c63f (patch)
tree6b4fc05249dba2e535d9fe89a6c130a43aee129a /Documentation
parent0c601052a5f761fd9c207a56ae11789c8598e25d (diff)
parent3d3adaad914441a6e7b916eb8dfd5ae638aab068 (diff)
downloadgit-810dc6481ad7c1e1a6aacebfeaed308778c6c63f.zip
git-810dc6481ad7c1e1a6aacebfeaed308778c6c63f.tar.gz
git-810dc6481ad7c1e1a6aacebfeaed308778c6c63f.tar.bz2
Merge branch 'js/trace2-env-vars'
Trace2 enhancement to allow logging of the environment variables. * js/trace2-env-vars: trace2: teach Git to log environment variables
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/config/trace2.txt9
-rw-r--r--Documentation/technical/api-trace2.txt3
2 files changed, 11 insertions, 1 deletions
diff --git a/Documentation/config/trace2.txt b/Documentation/config/trace2.txt
index 4ce0b9a..01d3afd 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.
diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
index 4f07cea..6b60855 100644
--- a/Documentation/technical/api-trace2.txt
+++ b/Documentation/technical/api-trace2.txt
@@ -656,7 +656,8 @@ The "exec_id" field is a command-unique id and is only useful if the
------------
`"def_param"`::
- This event is generated to log a global parameter.
+ This event is generated to log a global parameter, such as a config
+ setting, command-line flag, or environment variable.
+
------------
{