Re: [PATCH 3/6] git.1: Clarify the behavior of the --paginate option
- From
Jeff King <peff@peff.net>
- Date
- Feb 15, 2010, 04:55 UTC
- Message-ID
- <20100215045535.GD3336@coredump.intra.peff.net>
- In-Reply-To
- <20100214120235.GC3499@progeny.tock>
On Sun, Feb 14, 2010 at 06:02:35AM -0600, Jonathan Nieder wrote:
Show 9 quoted lines
> The --paginate option is meant to negate the effect of an explicit or > implicit pager.<cmd> = false setting. Thus it turns the pager on if > output is going to a terminal rather than unconditionally. > > Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> > --- > Noticed while testing. (It might be nice to have an --always-paginate > facility to allow debugging by writing output from a pager into > something that is not a terminal.)
Hmm. I would have expected --pager to have the "always" effect, though I will admit I never actually use it (--no-pager, on the other hand...). But if nobody is complaining, I certainly don't want to change the behavior haphazardly, and documenting it makes sense. Thanks.
Show 13 quoted lines
> diff --git a/Documentation/git.txt b/Documentation/git.txt > index 01c4631..f26641a 100644 > --- a/Documentation/git.txt > +++ b/Documentation/git.txt > @@ -229,7 +229,10 @@ help ...`. > > -p:: > --paginate:: > - Pipe all output into 'less' (or if set, $PAGER). > + Pipe all output into 'less' (or if set, $PAGER) if standard > + output is a terminal. This overrides the `pager.<cmd>` > + configuration options (see the "Configuration Mechanism" section > + below).
The "Configuration Mechanism" section doesn't actually contain anything related. I guess you were going for "point to that section, and then it will point to the list of config", which explains this:
Show 7 quoted lines
> @@ -401,7 +404,8 @@ people. Here is an example: > ------------ > > Various commands read from the configuration file and adjust > -their operation accordingly. > +their operation accordingly. See linkgit:git-config[1] for a > +list.
which seemed at first to be unrelated (but I think is a good change regardless).
It seems like a long jump for somebody who doesn't know what pager.* does to follow, but I guess it doesn't hurt to try to provide pointers. I have long since forgotten what it is like to not know that "git-config" contains the list of options. :)
-Peff