[thirdparty/git.git] / Documentation / config / trace2.txt

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.

trace2.maxFiles::
	Integer.  When writing trace files to a target directory, do not
	write additional traces if we would exceed this many files. Instead,
	write a sentinel file that will block further tracing to this
	directory. Defaults to 0, which disables this check.
Commit	Line	Data
81567caf JH	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.
e4b75d6a	7	It may be overridden by the `GIT_TRACE2` environment variable.
81567caf JH	8	The following table shows possible values.
	9
	10	trace2.perfTarget::
	11	This variable controls the performance target destination.
e4b75d6a	12	It may be overridden by the `GIT_TRACE2_PERF` environment variable.
81567caf JH	13	The following table shows possible values.
	14
	15	trace2.eventTarget::
	16	This variable controls the event target destination.
e4b75d6a	17	It may be overridden by the `GIT_TRACE2_EVENT` environment variable.
81567caf JH	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
e4b75d6a	25	`GIT_TRACE2_BRIEF` environment variable. Defaults to false.
81567caf JH	26
	27	trace2.perfBrief::
	28	Boolean. When true `time`, `filename`, and `line` fields are
	29	omitted from PERF output. May be overridden by the
e4b75d6a	30	`GIT_TRACE2_PERF_BRIEF` environment variable. Defaults to false.
81567caf JH	31
	32	trace2.eventBrief::
	33	Boolean. When true `time`, `filename`, and `line` fields are
	34	omitted from event output. May be overridden by the
e4b75d6a	35	`GIT_TRACE2_EVENT_BRIEF` environment variable. Defaults to false.
81567caf JH	36
	37	trace2.eventNesting::
	38	Integer. Specifies desired depth of nested regions in the
	39	event output. Regions deeper than this value will be
e4b75d6a	40	omitted. May be overridden by the `GIT_TRACE2_EVENT_NESTING`
81567caf JH	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.
e4b75d6a	48	May be overridden by the `GIT_TRACE2_CONFIG_PARAMS` environment
81567caf JH	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
e4b75d6a	56	`GIT_TRACE2_DST_DEBUG` environment variable.
83e57b04 JS	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.