Merge branch 'bc/wildcard-credential'
[git] / Documentation / config / trace2.txt
1 Trace2 config settings are only read from the system and global
2 config files; repository local and worktree config files and `-c`
3 command line arguments are not respected.
4
5 trace2.normalTarget::
6         This variable controls the normal target destination.
7         It may be overridden by the `GIT_TRACE2` environment variable.
8         The following table shows possible values.
9
10 trace2.perfTarget::
11         This variable controls the performance target destination.
12         It may be overridden by the `GIT_TRACE2_PERF` environment variable.
13         The following table shows possible values.
14
15 trace2.eventTarget::
16         This variable controls the event target destination.
17         It may be overridden by the `GIT_TRACE2_EVENT` environment variable.
18         The following table shows possible values.
19 +
20 include::../trace2-target-values.txt[]
21
22 trace2.normalBrief::
23         Boolean.  When true `time`, `filename`, and `line` fields are
24         omitted from normal output.  May be overridden by the
25         `GIT_TRACE2_BRIEF` environment variable.  Defaults to false.
26
27 trace2.perfBrief::
28         Boolean.  When true `time`, `filename`, and `line` fields are
29         omitted from PERF output.  May be overridden by the
30         `GIT_TRACE2_PERF_BRIEF` environment variable.  Defaults to false.
31
32 trace2.eventBrief::
33         Boolean.  When true `time`, `filename`, and `line` fields are
34         omitted from event output.  May be overridden by the
35         `GIT_TRACE2_EVENT_BRIEF` environment variable.  Defaults to false.
36
37 trace2.eventNesting::
38         Integer.  Specifies desired depth of nested regions in the
39         event output.  Regions deeper than this value will be
40         omitted.  May be overridden by the `GIT_TRACE2_EVENT_NESTING`
41         environment variable.  Defaults to 2.
42
43 trace2.configParams::
44         A comma-separated list of patterns of "important" config
45         settings that should be recorded in the trace2 output.
46         For example, `core.*,remote.*.url` would cause the trace2
47         output to contain events listing each configured remote.
48         May be overridden by the `GIT_TRACE2_CONFIG_PARAMS` environment
49         variable.  Unset by default.
50
51 trace2.destinationDebug::
52         Boolean.  When true Git will print error messages when a
53         trace target destination cannot be opened for writing.
54         By default, these errors are suppressed and tracing is
55         silently disabled.  May be overridden by the
56         `GIT_TRACE2_DST_DEBUG` environment variable.
57
58 trace2.maxFiles::
59         Integer.  When writing trace files to a target directory, do not
60         write additional traces if we would exceed this many files. Instead,
61         write a sentinel file that will block further tracing to this
62         directory. Defaults to 0, which disables this check.