[PATCH] Documentation: document the pager.* configuration setting

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



It was already documented in RelNotes-1.6.0, but not in the git-config
manual page.

Signed-off-by: Miklos Vajna <vmiklos@xxxxxxxxxxxxxx>
---

On Fri, Aug 15, 2008 at 08:17:52PM -0700, Junio C Hamano <gitster@xxxxxxxxx> wrote:
> > Ugh, I just noticed that the example was wrong, because paging for
> > status is disabled by default. Here is a corrected version.
>
> Honestly, I do not think the distinction between your two versions
> matter.
> Do we need a new example there?

That is a frequently asked question on #git (in the past, people asked
how to disable it, now they ask how to enable it), so I thought an
example can be helpful. Also Jeff provided such an example in the commit
message of 4e10738.

If you think it's unnecessary, then just remove that hunk.

> The patch to Documentation/config.txt looks Ok, but I do not think you
> need to say "allows to set your preference".  "Sets your preference"
> would
> be enough.

Fixed. I also noticed that above the documentation uses "Specify" and
not "Specifies" in such a case, so I dropped the "s" here as well.

 Documentation/config.txt     |    5 +++++
 Documentation/git-config.txt |    6 ++++++
 2 files changed, 11 insertions(+), 0 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index b8ec01c..dc70ba6 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -978,6 +978,11 @@ pack.packSizeLimit::
 	can be overridden by the `\--max-pack-size` option of
 	linkgit:git-repack[1].
 
+pager.<cmd>::
+	Set your pager preference for each command, overriding the default. If
+	`\--pager` or `\--no-pager` is specified on the command line, it takes
+	precedence over this option.
+
 pull.octopus::
 	The default merge strategy to use when pulling multiple branches
 	at once.
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 28e1861..c0bc6fa 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -315,6 +315,12 @@ RESET=$(git config --get-color "" "reset")
 echo "${WS}your whitespace color or blue reverse${RESET}"
 ------------
 
+To enable the pager for linkgit:git-status[1]:
+
+------------
+% git config pager.status true
+------------
+
 include::config.txt[]
 
 
-- 
1.6.0.rc0.14.g95f8.dirty

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux