threads / patch / 15031

patchDocumentation: document the pager.* configuration setting

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

## tl;dr

5 messages between Aug 16, 2008 and Aug 16, 2008. Diffs are folded; open one to read it.

replies: 4people: 2as markdown or json

Miklos Vajna· Aug 16, 2008, 02:09 UTC · lore

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

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---
 Documentation/config.txt     |    5 +++++
 Documentation/git-config.txt |    6 ++++++
 2 files changed, 11 insertions(+), 0 deletions(-)
Show changes to 2 files +11 −0

Documentation/config.txt, Documentation/git-config.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index b8ec01c..676c39b 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>::
+	Allows to set your own pager preferences 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..d869942 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 disable the pager for linkgit:git-status[1]:
+
+------------
+% git config pager.status false
+------------
+
 include::config.txt[]
 
 
-- 
1.6.0.rc0.14.g95f8.dirty
Miklos Vajna· Aug 16, 2008, 02:14 UTC · re: Miklos Vajna · lore

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

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---

Ugh, I just noticed that the example was wrong, because paging for status is disabled by default. Here is a corrected version.

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

Documentation/config.txt, Documentation/git-config.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index b8ec01c..676c39b 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>::
+	Allows to set your own pager preferences 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
Junio C Hamano· Aug 16, 2008, 03:17 UTC · re: Miklos Vajna · lore

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

Miklos Vajna <vmiklos@frugalware.org> writes:
Show 8 quoted lines
> It was already documented in RelNotes-1.6.0, but not in the git-config
> manual page.
>
> Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
> ---
>
> 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?

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.

Miklos Vajna· Aug 16, 2008, 13:38 UTC · re: Junio C Hamano · lore

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

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---
On Fri, Aug 15, 2008 at 08:17:52PM -0700, Junio C Hamano <gitster@pobox.com> wrote:
Show 6 quoted lines
> > 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(-)
Show changes to 2 files +11 −0

Documentation/config.txt, Documentation/git-config.txt

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
Miklos Vajna· Aug 16, 2008, 13:43 UTC · re: Miklos Vajna · lore

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

On Sat, Aug 16, 2008 at 03:38:13PM +0200, Miklos Vajna <vmiklos@frugalware.org> wrote:
> Fixed.

Ah, nevermind. I forgot to pull before sending the patch and I did not notice the version without the second hunk is already in master.

Sorry for the noise.

← back to recent threads