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

From: Jeff King <peff@peff.net>
Date: Jun 9, 2013, 05:55 UTC
Message-ID: <20130609055509.GA17617@sigill.intra.peff.net>
In-Reply-To: <1370757210-2994-1-git-send-email-pclouds@gmail.com>

On Sun, Jun 09, 2013 at 12:53:30PM +0700, Nguyen Thai Ngoc Duy wrote:

Show 19 quoted lines

> "This can help with debugging object negotiation or other protocol
> issues."
> 
> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> ---
>  >> +'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?

Hmm, what do you know, I sort-of documented it already. I think I just never guessed that anybody but people reading "git log" would actually need to use TRACE_PACKET. :)

Thanks, the patch looks fine to me.

-Peff