Patchwork [4,of,6,STABLE] help: apply bulk fixes for indentation and literal blocking issues

login
register
mail settings
Submitter Katsunori FUJIWARA
Date April 30, 2017, 8:54 p.m.
Message ID <091d6b9157da08a36f65.1493585646@speaknoevil>
Download mbox | patch
Permalink /patch/20316/
State Accepted
Headers show

Comments

Katsunori FUJIWARA - April 30, 2017, 8:54 p.m.
# HG changeset patch
# User FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
# Date 1493585552 -32400
#      Mon May 01 05:52:32 2017 +0900
# Branch stable
# Node ID 091d6b9157da08a36f65102fca85dc6017294a4c
# Parent  1c911adebf488246c720d98f77be349c8c82d708
help: apply bulk fixes for indentation and literal blocking issues

There are some paragraphs, which aren't rendered in online help as
expected because of indentation and literal blocking issues.

- hgext/rebase.py

  - paragraph before example code ends with ":", which treats
    subsequent indented paragraphs as normal block

    => replace ":" with "::" to treat subsequent paragraphs as literal block

- help/pager.txt

  - paragraph before a list of --pager option values ends with "::",
    which treats subsequent indented paragraphs as literal block

    => replace "::" with ":" to treat subsequent paragraphs as normal block

  - the second line of explanation for no/off --pager option value is
    indented incorrectly (this also causes failure of "make" in doc)

    => indent correctly

- help/revisions.txt

  - explanation following example code of "[revsetalias]" section
    isn't suitable for literal block

    => un-indent explanation paragraph to treat it as normal block

  - indentation of "For example" before example of tag() revset
    predicate matching is meaningless

  - descriptive text for tag() revset predicate matching isn't
    suitable for literal block

    => un-indent concatenated two paragraphs to treat them as normal block

Patch

diff --git a/hgext/rebase.py b/hgext/rebase.py
--- a/hgext/rebase.py
+++ b/hgext/rebase.py
@@ -665,7 +665,7 @@  def rebase(ui, repo, **opts):
     Configuration Options:
 
     You can make rebase require a destination if you set the following config
-    option:
+    option::
 
       [commands]
       rebase.requiredest = True
diff --git a/mercurial/help/pager.txt b/mercurial/help/pager.txt
--- a/mercurial/help/pager.txt
+++ b/mercurial/help/pager.txt
@@ -20,12 +20,12 @@  To ignore global commands like :hg:`vers
 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>::
+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).
+    will also work).
 
 To globally turn off all attempts to use a pager, set::
 
diff --git a/mercurial/help/revisions.txt b/mercurial/help/revisions.txt
--- a/mercurial/help/revisions.txt
+++ b/mercurial/help/revisions.txt
@@ -109,10 +109,10 @@  These are the supported infix operators:
     [revsetalias]
     issue(a1) = grep(r'\bissue[ :]?' ## a1 ## r'\b|\bbug\(' ## a1 ## r'\)')
 
-    ``issue(1234)`` is equivalent to
-    ``grep(r'\bissue[ :]?1234\b|\bbug\(1234\)')``
-    in this case. This matches against all of "issue 1234", "issue:1234",
-    "issue1234" and "bug(1234)".
+  ``issue(1234)`` is equivalent to
+  ``grep(r'\bissue[ :]?1234\b|\bbug\(1234\)')``
+  in this case. This matches against all of "issue 1234", "issue:1234",
+  "issue1234" and "bug(1234)".
 
 There is a single postfix operator:
 
@@ -132,9 +132,8 @@  Matching is case-sensitive, unless other
 insensitive match on a case-sensitive predicate, use a regular expression,
 prefixed with ``(?i)``.
 
-  For example::
-
-    ``tag(r're:(?i)release')`` matches "release" or "RELEASE" or "Release", etc
+For example, ``tag(r're:(?i)release')`` matches "release" or "RELEASE"
+or "Release", etc
 
 Predicates
 ==========