Skip to content

Commit eb9250d

Browse files
kbleesgitster
authored andcommitted
Documentation/git.txt: improve documentation of 'GIT_TRACE*' variables
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 6aa3085 commit eb9250d

File tree

1 file changed

+34
-16
lines changed

1 file changed

+34
-16
lines changed

Documentation/git.txt

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -904,18 +904,25 @@ for further details.
904904
based on whether stdout appears to be redirected to a file or not.
905905

906906
'GIT_TRACE'::
907-
If this variable is set to "1", "2" or "true" (comparison
908-
is case insensitive), Git will print `trace:` messages on
909-
stderr telling about alias expansion, built-in command
910-
execution and external command execution.
911-
If this variable is set to an integer value greater than 1
912-
and lower than 10 (strictly) then Git will interpret this
913-
value as an open file descriptor and will try to write the
914-
trace messages into this file descriptor.
915-
Alternatively, if this variable is set to an absolute path
916-
(starting with a '/' character), Git will interpret this
917-
as a file path and will try to write the trace messages
918-
into it.
907+
Enables general trace messages, e.g. alias expansion, built-in
908+
command execution and external command execution.
909+
+
910+
If this variable is set to "1", "2" or "true" (comparison
911+
is case insensitive), trace messages will be printed to
912+
stderr.
913+
+
914+
If the variable is set to an integer value greater than 2
915+
and lower than 10 (strictly) then Git will interpret this
916+
value as an open file descriptor and will try to write the
917+
trace messages into this file descriptor.
918+
+
919+
Alternatively, if the variable is set to an absolute path
920+
(starting with a '/' character), Git will interpret this
921+
as a file path and will try to write the trace messages
922+
into it.
923+
+
924+
Unsetting the variable, or setting it to empty, "0" or
925+
"false" (case insensitive) disables trace messages.
919926

920927
'GIT_TRACE_PACK_ACCESS'::
921928
If this variable is set to a path, a file will be created at
@@ -925,10 +932,21 @@ for further details.
925932
pack-related performance problems.
926933

927934
'GIT_TRACE_PACKET'::
928-
If this variable is set, it shows a trace of all packets
929-
coming in or out of a given program. This can help with
930-
debugging object negotiation or other protocol issues. Tracing
931-
is turned off at a packet starting with "PACK".
935+
Enables trace messages for all packets coming in or out of a
936+
given program. This can help with debugging object negotiation
937+
or other protocol issues. Tracing is turned off at a packet
938+
starting with "PACK".
939+
See 'GIT_TRACE' for available trace output options.
940+
941+
'GIT_TRACE_SETUP'::
942+
Enables trace messages printing the .git, working tree and current
943+
working directory after Git has completed its setup phase.
944+
See 'GIT_TRACE' for available trace output options.
945+
946+
'GIT_TRACE_SHALLOW'::
947+
Enables trace messages that can help debugging fetching /
948+
cloning of shallow repositories.
949+
See 'GIT_TRACE' for available trace output options.
932950

933951
GIT_LITERAL_PATHSPECS::
934952
Setting this variable to `1` will cause Git to treat all

0 commit comments

Comments
 (0)