mirror of
https://github.com/git/git.git
synced 2024-10-30 22:07:53 +01:00
e4b75d6a1d
For an environment variable that is supposed to be set by users, the GIT_TR2* env vars are just too unclear, inconsistent, and ugly. Most of the established GIT_* environment variables don't use abbreviations, and in case of the few that do (GIT_DIR, GIT_COMMON_DIR, GIT_DIFF_OPTS) it's quite obvious what the abbreviations (DIR and OPTS) stand for. But what does TR stand for? Track, traditional, trailer, transaction, transfer, transformation, transition, translation, transplant, transport, traversal, tree, trigger, truncate, trust, or ...?! The trace2 facility, as the '2' suffix in its name suggests, is supposed to eventually supercede Git's original trace facility. It's reasonable to expect that the corresponding environment variables follow suit, and after the original GIT_TRACE variables they are called GIT_TRACE2; there is no such thing is 'GIT_TR'. All trace2-specific config variables are, very sensibly, in the 'trace2' section, not in 'tr2'. OTOH, we don't gain anything at all by omitting the last three characters of "trace" from the names of these environment variables. So let's rename all GIT_TR2* environment variables to GIT_TRACE2*, before they make their way into a stable release. Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
56 lines
2.2 KiB
Text
56 lines
2.2 KiB
Text
Trace2 config settings are only read from the system and global
|
|
config files; repository local and worktree config files and `-c`
|
|
command line arguments are not respected.
|
|
|
|
trace2.normalTarget::
|
|
This variable controls the normal target destination.
|
|
It may be overridden by the `GIT_TRACE2` environment variable.
|
|
The following table shows possible values.
|
|
|
|
trace2.perfTarget::
|
|
This variable controls the performance target destination.
|
|
It may be overridden by the `GIT_TRACE2_PERF` environment variable.
|
|
The following table shows possible values.
|
|
|
|
trace2.eventTarget::
|
|
This variable controls the event target destination.
|
|
It may be overridden by the `GIT_TRACE2_EVENT` environment variable.
|
|
The following table shows possible values.
|
|
+
|
|
include::../trace2-target-values.txt[]
|
|
|
|
trace2.normalBrief::
|
|
Boolean. When true `time`, `filename`, and `line` fields are
|
|
omitted from normal output. May be overridden by the
|
|
`GIT_TRACE2_BRIEF` environment variable. Defaults to false.
|
|
|
|
trace2.perfBrief::
|
|
Boolean. When true `time`, `filename`, and `line` fields are
|
|
omitted from PERF output. May be overridden by the
|
|
`GIT_TRACE2_PERF_BRIEF` environment variable. Defaults to false.
|
|
|
|
trace2.eventBrief::
|
|
Boolean. When true `time`, `filename`, and `line` fields are
|
|
omitted from event output. May be overridden by the
|
|
`GIT_TRACE2_EVENT_BRIEF` environment variable. Defaults to false.
|
|
|
|
trace2.eventNesting::
|
|
Integer. Specifies desired depth of nested regions in the
|
|
event output. Regions deeper than this value will be
|
|
omitted. May be overridden by the `GIT_TRACE2_EVENT_NESTING`
|
|
environment variable. Defaults to 2.
|
|
|
|
trace2.configParams::
|
|
A comma-separated list of patterns of "important" config
|
|
settings that should be recorded in the trace2 output.
|
|
For example, `core.*,remote.*.url` would cause the trace2
|
|
output to contain events listing each configured remote.
|
|
May be overridden by the `GIT_TRACE2_CONFIG_PARAMS` 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.
|
|
By default, these errors are suppressed and tracing is
|
|
silently disabled. May be overridden by the
|
|
`GIT_TRACE2_DST_DEBUG` environment variable.
|