[PATCH 3/7] git.1: Clarify the behavior of the --paginate option
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- Feb 19, 2010, 07:06 UTC
- Message-ID
- <20100219070639.GC29916@progeny.tock>
- In-Reply-To
- <20100219065010.GA22258@progeny.tock>
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.
Explaining this requires mentioning configuration options very early in the manual, when some users might not be familiar with them yet. Provide some pointers to help: to the relevant section of git.1 for the configuration mechanism in general and to git-config.1 for the pager.<cmd> options.
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> --- Add a second paragraph to explain the less obvious part of the patch. Jeff reverse-engineered this all correctly in [1], but one shouldn’t have to think that hard to see where a patch is coming from.
http://thread.gmane.org/gmane.comp.version-control.git/139831/focus=139971
Documentation/git.txt | 8 ++++++-- 1 files changed, 6 insertions(+), 2 deletions(-)
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). --no-pager:: Do not pipe git output into a pager. @@ -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. Identifier Terminology
-- 1.7.0