undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation/git.txt: improve documentation of 'GIT_TRACE*' variables

Browse Source 
Separate GIT_TRACE description into what it prints and how to configure
where trace output is printed to. Change other GIT_TRACE_* descriptions to
refer to GIT_TRACE.

Add descriptions for GIT_TRACE_SETUP and GIT_TRACE_SHALLOW.

Signed-off-by: Karsten Blees <blees@dcon.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Karsten Blees 2014-07-12 02:00:53 +02:00 committed by Junio C Hamano
parent 6aa3085702
commit eb9250dfd5
1 changed files with 34 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
Documentation/git.txt
View File

@ -904,18 +904,25 @@ for further details.
based on whether stdout appears to be redirected to a file or not. based on whether stdout appears to be redirected to a file or not.
'GIT_TRACE':: 'GIT_TRACE'::
If this variable is set to "1", "2" or "true" (comparison Enables general trace messages, e.g. alias expansion, built-in
is case insensitive), Git will print `trace:` messages on command execution and external command execution.
stderr telling about alias expansion, built-in command +
execution and external command execution. If this variable is set to "1", "2" or "true" (comparison
If this variable is set to an integer value greater than 1 is case insensitive), trace messages will be printed to
and lower than 10 (strictly) then Git will interpret this stderr.
value as an open file descriptor and will try to write the +
trace messages into this file descriptor. If the variable is set to an integer value greater than 2
Alternatively, if this variable is set to an absolute path and lower than 10 (strictly) then Git will interpret this
(starting with a '/' character), Git will interpret this value as an open file descriptor and will try to write the
as a file path and will try to write the trace messages trace messages into this file descriptor.
into it. +
Alternatively, if the variable is set to an absolute path
(starting with a '/' character), Git will interpret this
as a file path and will try to write the trace messages
into it.
+
Unsetting the variable, or setting it to empty, "0" or
"false" (case insensitive) disables trace messages.
'GIT_TRACE_PACK_ACCESS':: 'GIT_TRACE_PACK_ACCESS'::
If this variable is set to a path, a file will be created at If this variable is set to a path, a file will be created at
@ -925,10 +932,21 @@ for further details.
pack-related performance problems. pack-related performance problems.
'GIT_TRACE_PACKET':: 'GIT_TRACE_PACKET'::
If this variable is set, it shows a trace of all packets Enables trace messages for all packets coming in or out of a
coming in or out of a given program. This can help with given program. This can help with debugging object negotiation
debugging object negotiation or other protocol issues. Tracing or other protocol issues. Tracing is turned off at a packet
is turned off at a packet starting with "PACK". starting with "PACK".
See 'GIT_TRACE' for available trace output options.
'GIT_TRACE_SETUP'::
Enables trace messages printing the .git, working tree and current
working directory after Git has completed its setup phase.
See 'GIT_TRACE' for available trace output options.
'GIT_TRACE_SHALLOW'::
Enables trace messages that can help debugging fetching /
cloning of shallow repositories.
See 'GIT_TRACE' for available trace output options.
GIT_LITERAL_PATHSPECS:: GIT_LITERAL_PATHSPECS::
Setting this variable to `1` will cause Git to treat all Setting this variable to `1` will cause Git to treat all