git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: Sebastian Celis <sebastian@sebastiancelis.com>,
	Jeff King <peff@peff.net>, Junio C Hamano <gitster@pobox.com>,
	Johannes Sixt <j6t@kdbg.org>
Subject: [PATCH 3/7] git.1: Clarify the behavior of the --paginate option
Date: Fri, 19 Feb 2010 01:06:39 -0600	[thread overview]
Message-ID: <20100219070639.GC29916@progeny.tock> (raw)
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

  parent reply	other threads:[~2010-02-19  7:06 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-02-19  6:50 [PATCH v2 0/7] Re: 'git svn log' no longer uses the pager Jonathan Nieder
2010-02-19  6:51 ` [PATCH 1/7] Fix 'git var' usage synopsis Jonathan Nieder
2010-02-19  7:00 ` [PATCH 2/7] Make 'git var GIT_PAGER' always print the configured pager Jonathan Nieder
2010-02-19  7:06 ` Jonathan Nieder [this message]
2010-02-19  7:09 ` [PATCH 4/7] git svn: Fix launching of pager Jonathan Nieder
2010-02-19  7:12 ` [PATCH 5/7] am: " Jonathan Nieder
2010-02-19  7:18 ` [PATCH 6/7] tests: Add tests for automatic use " Jonathan Nieder
2010-02-20 17:33   ` Junio C Hamano
2010-02-21  2:03     ` [PATCH v2 " Jonathan Nieder
2010-02-21  2:09       ` [PATCH v4 7/7] t7006-pager: if stdout is not a terminal, make a new one Jonathan Nieder
2010-02-21  7:30         ` Jeff King
2010-02-22  8:19       ` [PATCH v2 6/7] tests: Add tests for automatic use of pager Johannes Sixt
2010-02-22  8:46         ` [PATCH 8/7] tests: Fix race condition in t7006-pager Jonathan Nieder
2010-02-22  9:12           ` Jonathan Nieder
2010-02-19  7:23 ` [PATCH/RFC 7/7] t7006-pager: if stdout is not a terminal, make a new one Jonathan Nieder
2010-02-19  8:08   ` Jeff King
2010-02-19  8:19     ` Jonathan Nieder
2010-02-19  8:34       ` Jeff King
2010-02-19 16:25         ` Brandon Casey
2010-02-20  0:29           ` Brandon Casey
2010-02-20  0:39             ` Jonathan Nieder
2010-02-20  3:42               ` Brandon Casey
2010-02-20  5:25                 ` [PATCH v2 " Jonathan Nieder
2010-02-20  6:53                   ` Junio C Hamano
2010-02-20  8:50                     ` [PATCH v3 " Jonathan Nieder
2010-02-20  9:48                       ` [PATCH squash] Simplify test-terminal.perl Jonathan Nieder

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20100219070639.GC29916@progeny.tock \
    --to=jrnieder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=j6t@kdbg.org \
    --cc=peff@peff.net \
    --cc=sebastian@sebastiancelis.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).