Re: [PATCH] Documentation: talk about pager in api-trace.txt

From: Christian Couder <christian.couder@gmail.com>
Date: Mar 3, 2016, 09:17 UTC
Message-ID: <CAP8UFD38odsz=fwE9E+0fVJXFE-4vwL1vTQT0rshyCAUYO1fcw@mail.gmail.com>
In-Reply-To: <20160229213152.GC25342@sigill.intra.peff.net>

On Mon, Feb 29, 2016 at 10:31 PM, Jeff King <peff@peff.net> wrote:

Show 10 quoted lines

> On Mon, Feb 29, 2016 at 03:21:20PM +0100, Christian Couder wrote:
>
>> Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
>> ---
>>  Documentation/technical/api-trace.txt | 43 +++++++++++++++++++++++++++++++++++
>>  1 file changed, 43 insertions(+)
>
> I think this is fine. I'm not sure how many people would look at the
> technical/api documentation in such a case, but I don't think it hurts
> to document this stuff.

Yeah.

Junio do you plan to merge this patch or would you prefer something like:

+ +Bugs & Caveats +-------------- + +Some git commands, like `git log`, are run by default using a +pager. In this case, stdout and stderr are redirected to the pager and +are closed when the pager exits. + +If a GIT_TRACE* environment variable has been set to "1" or "2" to +print traces on stderr, no trace output will be printed after the +pager has exited. + +This can be annoying, because GIT_TRACE_PERFORMANCE by default prints +the performance stats for the whole command at atexit() time which +happens after the pager has exited. + +So the following command will print no performance stat: + +------------ +GIT_TRACE_PERFORMANCE=2 git log -1 +------------ + +To overcome this problem, you can use for example: + +------------ +GIT_TRACE_PERFORMANCE=2 git --no-pager log -1 +------------