[PATCH 1 of 2 pager-endgame] pager: move most help to a new help topic and deprecate extension
Augie Fackler
raf at durin42.com
Tue Feb 21 21:18:12 UTC 2017
# HG changeset patch
# User Augie Fackler <augie at google.com>
# Date 1486444073 18000
# Tue Feb 07 00:07:53 2017 -0500
# Node ID 589dcabe2b7a2b9f2d49646d710335e5a70ad492
# Parent 59e69ed81776f0186cb6e6c69f8d7659afab26b7
pager: move most help to a new help topic and deprecate extension
diff --git a/hgext/pager.py b/hgext/pager.py
--- a/hgext/pager.py
+++ b/hgext/pager.py
@@ -12,51 +12,14 @@
#
# Run 'hg help pager' to get info on configuration.
-'''browse command output with an external pager
-
-To set the pager that should be used, set the application variable::
-
- [pager]
- pager = less -FRX
-
-If no pager is set, the pager extensions uses the environment variable
-$PAGER. If neither pager.pager, nor $PAGER is set, no pager is used.
-
-You can disable the pager for certain commands by adding them to the
-pager.ignore list::
+'''browse command output with an external pager (DEPRECATED)
- [pager]
- ignore = version, help, update
-
-You can also enable the pager only for certain commands using
-pager.attend. Below is the default list of commands to be paged::
-
- [pager]
- attend = annotate, cat, diff, export, glog, log, qdiff
-
-Setting pager.attend to an empty value will cause all commands to be
-paged.
-
-If pager.attend is present, pager.ignore will be ignored.
-
-Lastly, you can enable and disable paging for individual commands with
-the attend-<command> option. This setting takes precedence over
-existing attend and ignore options and defaults::
+Forcibly enable paging for individual commands that don't typically
+request pagination with the attend-<command> option. This setting
+takes precedence over ignore options and defaults::
[pager]
attend-cat = false
-
-To ignore global commands like :hg:`version` or :hg:`help`, you have
-to specify them in your user configuration file.
-
-To control whether the pager is used at all for an individual command,
-you can use --pager=<value>::
-
- - use as needed: `auto`.
- - require the pager: `yes` or `on`.
- - suppress the pager: `no` or `off` (any unrecognized value
- will also work).
-
'''
from __future__ import absolute_import
diff --git a/mercurial/help.py b/mercurial/help.py
--- a/mercurial/help.py
+++ b/mercurial/help.py
@@ -230,6 +230,7 @@ helptable = sorted([
loaddoc('scripting')),
(['internals'], _("Technical implementation topics"),
internalshelp),
+ (['pager'], _("Pager Support"), loaddoc('pager')),
])
# Maps topics with sub-topics to a list of their sub-topics.
diff --git a/mercurial/help/pager.txt b/mercurial/help/pager.txt
new file mode 100644
--- /dev/null
+++ b/mercurial/help/pager.txt
@@ -0,0 +1,28 @@
+Some Mercurial commands produce a lot of output, and Mercurial will
+attempt to use a pager to make those commands more pleasant.
+
+To set the pager that should be used, set the application variable::
+
+ [pager]
+ pager = less -FRX
+
+If no pager is set, the pager extensions uses the environment variable
+$PAGER. If neither pager.pager, nor $PAGER is set, a default pager
+will be used, typically `more`.
+
+You can disable the pager for certain commands by adding them to the
+pager.ignore list::
+
+ [pager]
+ ignore = version, help, update
+
+To ignore global commands like :hg:`version` or :hg:`help`, you have
+to specify them in your user configuration file.
+
+To control whether the pager is used at all for an individual command,
+you can use --pager=<value>::
+
+ - use as needed: `auto`.
+ - require the pager: `yes` or `on`.
+ - suppress the pager: `no` or `off` (any unrecognized value
+ will also work).
diff --git a/tests/test-globalopts.t b/tests/test-globalopts.t
--- a/tests/test-globalopts.t
+++ b/tests/test-globalopts.t
@@ -351,6 +351,7 @@ Testing -h/--help:
hgweb Configuring hgweb
internals Technical implementation topics
merge-tools Merge Tools
+ pager Pager Support
patterns File Name Patterns
phases Working with Phases
revisions Specifying Revisions
@@ -432,6 +433,7 @@ Testing -h/--help:
hgweb Configuring hgweb
internals Technical implementation topics
merge-tools Merge Tools
+ pager Pager Support
patterns File Name Patterns
phases Working with Phases
revisions Specifying Revisions
diff --git a/tests/test-help.t b/tests/test-help.t
--- a/tests/test-help.t
+++ b/tests/test-help.t
@@ -113,6 +113,7 @@ Short help:
hgweb Configuring hgweb
internals Technical implementation topics
merge-tools Merge Tools
+ pager Pager Support
patterns File Name Patterns
phases Working with Phases
revisions Specifying Revisions
@@ -188,6 +189,7 @@ Short help:
hgweb Configuring hgweb
internals Technical implementation topics
merge-tools Merge Tools
+ pager Pager Support
patterns File Name Patterns
phases Working with Phases
revisions Specifying Revisions
@@ -262,7 +264,6 @@ Test extension help:
largefiles track large binary files
mq manage a stack of patches
notify hooks for sending email push notifications
- pager browse command output with an external pager
patchbomb command to send changesets as (a series of) patch emails
purge command to delete untracked files from the working
directory
@@ -831,6 +832,7 @@ Test that default list of commands omits
hgweb Configuring hgweb
internals Technical implementation topics
merge-tools Merge Tools
+ pager Pager Support
patterns File Name Patterns
phases Working with Phases
revisions Specifying Revisions
@@ -1918,6 +1920,13 @@ Dish up an empty repo; serve it cold.
Merge Tools
</td></tr>
<tr><td>
+ <a href="/help/pager">
+ pager
+ </a>
+ </td><td>
+ Pager Support
+ </td></tr>
+ <tr><td>
<a href="/help/patterns">
patterns
</a>
diff --git a/tests/test-hgweb-json.t b/tests/test-hgweb-json.t
--- a/tests/test-hgweb-json.t
+++ b/tests/test-hgweb-json.t
@@ -1593,6 +1593,10 @@ help/ shows help topics
"topic": "merge-tools"
},
{
+ "summary": "Pager Support",
+ "topic": "pager"
+ },
+ {
"summary": "File Name Patterns",
"topic": "patterns"
},
diff --git a/tests/test-install.t b/tests/test-install.t
--- a/tests/test-install.t
+++ b/tests/test-install.t
@@ -166,6 +166,7 @@ path variables are expanded (~ is the sa
help/hg.1.txt
help/hgignore.5.txt
help/hgrc.5.txt
+ help/pager.txt
Not tracked:
$ python wixxml.py templates
More information about the Mercurial-devel
mailing list