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 <blees@dcon.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Karsten Blees committed
Jul 12, 2014 at 02:00 UTC
eb9250dfd5fbd7c9f95d0d3134006cd19a0c9099
1 file changed
+34
-16
Documentation/git.txt
+34
-16
@@ -904,18 +904,25 @@ for further details.
904
based on whether stdout appears to be redirected to a file or not.
905
906
'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.
926
927
'GIT_TRACE_PACK_ACCESS'::
928
If this variable is set to a path, a file will be created at
@@ -925,10 +932,21 @@ for further details.
932
pack-related performance problems.
933
934
'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.
950
951
GIT_LITERAL_PATHSPECS::
952
Setting this variable to `1` will cause Git to treat all