Subject: [PATCH 2/2] git.txt: document GIT_TRACE_PACKET

From: Nguyễn Thái Ngọc Duy <[email-masked]>
Date: Sun, 9 Jun 2013 12:53:30 +0700

"This can help with debugging object negotiation or other protocol
issues."

Signed-off-by: Nguyễn Thái Ngọc Duy <[email-masked]>
---
 >> +'GIT_TRACE_PACKET'::
 >> +     If this variable is set, it shows a trace of all packets
 >> +     coming in or out of a given program. This can help with
 >> +     debugging object negotiation or other protocol issues.
 >
 > This is not quite true. It stops showing packets after it sees a packet
 > starting with "PACK" (optionally with a sideband prefix). So you would
 > miss, for example, a sideband error that came after the pack had
 > started. So it is really only useful for looking at the ref and object
 > negotiation phases.

 I blindly copied the first paragraph from bbc30f9 (add packet tracing
 debug code - 2011-02-24) and missed the "PACK" bit in the second one.
 How about this?

 Documentation/git.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/git.txt b/Documentation/git.txt
index c760918..c10b647 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -845,6 +845,12 @@ for further details.
 	recorded. This may be helpful for troubleshooting some
 	pack-related performance problems.
 
+'GIT_TRACE_PACKET'::
+	If this variable is set, it shows a trace of all packets
+	coming in or out of a given program. This can help with
+	debugging object negotiation or other protocol issues. Tracing
+	is turned off at a packet starting with "PACK".
+
 GIT_LITERAL_PATHSPECS::
 	Setting this variable to `1` will cause Git to treat all
 	pathspecs literally, rather than as glob patterns. For example,
-- 
1.8.2.83.gc99314b