Use our custom hg reStructuredText role some more
authorMartin Geisler <mg@aragost.com>
Tue, 18 May 2010 16:31:10 +0200
changeset 11193 687c7d395f20
parent 11192 babf9a5f5528
child 11196 573bef78763f
Use our custom hg reStructuredText role some more I missed these occurrences on my first scan through the source.
hgext/bookmarks.py
hgext/gpg.py
hgext/hgk.py
hgext/keyword.py
hgext/mq.py
hgext/patchbomb.py
hgext/transplant.py
mercurial/commands.py
tests/test-help.out
--- a/hgext/bookmarks.py	Tue May 18 16:24:14 2010 +0200
+++ b/hgext/bookmarks.py	Tue May 18 16:31:10 2010 +0200
@@ -12,8 +12,8 @@
 changeset that is based on a changeset that has a bookmark on it, the
 bookmark shifts to the new changeset.
 
-It is possible to use bookmark names in every revision lookup (e.g. hg
-merge, hg update).
+It is possible to use bookmark names in every revision lookup (e.g.
+:hg:`merge`, :hg:`update`).
 
 By default, when several bookmarks point to the same changeset, they
 will all move forward together. It is possible to obtain a more
--- a/hgext/gpg.py	Tue May 18 16:24:14 2010 +0200
+++ b/hgext/gpg.py	Tue May 18 16:31:10 2010 +0200
@@ -197,7 +197,7 @@
     If no revision is given, the parent of the working directory is used,
     or tip if no revision is checked out.
 
-    See 'hg help dates' for a list of formats valid for -d/--date.
+    See :hg:`help dates` for a list of formats valid for -d/--date.
     """
 
     mygpg = newgpg(ui, **opts)
--- a/hgext/hgk.py	Tue May 18 16:24:14 2010 +0200
+++ b/hgext/hgk.py	Tue May 18 16:31:10 2010 +0200
@@ -17,7 +17,7 @@
 the contrib directory, and the extension is shipped in the hgext
 repository, and needs to be enabled.
 
-The hg view command will launch the hgk Tcl script. For this command
+The :hg:`view` command will launch the hgk Tcl script. For this command
 to work, hgk must be in your search path. Alternately, you can specify
 the path to hgk in your .hgrc file::
 
--- a/hgext/keyword.py	Tue May 18 16:24:14 2010 +0200
+++ b/hgext/keyword.py	Tue May 18 16:31:10 2010 +0200
@@ -281,7 +281,7 @@
 
     Use -d/--default to disable current configuration.
 
-    See "hg help templates" for information on templates and filters.
+    See :hg:`help templates` for information on templates and filters.
     '''
     def demoitems(section, items):
         ui.write('[%s]\n' % section)
--- a/hgext/mq.py	Tue May 18 16:24:14 2010 +0200
+++ b/hgext/mq.py	Tue May 18 16:31:10 2010 +0200
@@ -1836,7 +1836,7 @@
     qcommit to commit changes to this queue repository.
 
     This command is deprecated. Without -c, it's implied by other relevant
-    commands. With -c, use hg init --mq instead."""
+    commands. With -c, use :hg:`init --mq` instead."""
     return qinit(ui, repo, create=opts['create_repo'])
 
 def clone(ui, source, dest=None, **opts):
@@ -1852,7 +1852,7 @@
     default. Use -p <url> to change.
 
     The patch directory must be a nested Mercurial repository, as
-    would be created by init --mq.
+    would be created by :hg:`init --mq`.
     '''
     def patchdir(repo):
         url = repo.url()
@@ -1906,7 +1906,7 @@
 def commit(ui, repo, *pats, **opts):
     """commit changes in the queue repository (DEPRECATED)
 
-    This command is deprecated; use hg commit --mq instead."""
+    This command is deprecated; use :hg:`commit --mq` instead."""
     q = repo.mq
     r = q.qrepo()
     if not r:
@@ -2371,8 +2371,8 @@
     completes.
 
     Any stripped changesets are stored in ``.hg/strip-backup`` as a
-    bundle (see ``hg help bundle`` and ``hg help unbundle``). They can
-    be restored by running ``hg unbundle .hg/strip-backup/BUNDLE``,
+    bundle (see :hg:`help bundle` and :hg:`help unbundle`). They can
+    be restored by running :hg:`unbundle .hg/strip-backup/BUNDLE`,
     where BUNDLE is the bundle file created by the strip. Note that
     the local revision numbers will in general be different after the
     restore.
--- a/hgext/patchbomb.py	Tue May 18 16:24:14 2010 +0200
+++ b/hgext/patchbomb.py	Tue May 18 16:31:10 2010 +0200
@@ -187,9 +187,9 @@
 def patchbomb(ui, repo, *revs, **opts):
     '''send changesets by email
 
-    By default, diffs are sent in the format generated by hg export,
-    one per message. The series starts with a "[PATCH 0 of N]"
-    introduction, which describes the series as a whole.
+    By default, diffs are sent in the format generated by
+    :hg:`export`, one per message. The series starts with a "[PATCH 0
+    of N]" introduction, which describes the series as a whole.
 
     Each patch email has a Subject line of "[PATCH M of N] ...", using
     the first line of the changeset description as the subject text.
--- a/hgext/transplant.py	Tue May 18 16:24:14 2010 +0200
+++ b/hgext/transplant.py	Tue May 18 16:31:10 2010 +0200
@@ -453,7 +453,7 @@
     transplanted, otherwise you will be prompted to select the
     changesets you want.
 
-    hg transplant --branch REVISION --all will rebase the selected
+    :hg:`transplant --branch REVISION --all` will rebase the selected
     branch (up to the named revision) onto your current working
     directory.
 
@@ -462,12 +462,12 @@
     of a merged transplant, and you can merge descendants of them
     normally instead of transplanting them.
 
-    If no merges or revisions are provided, hg transplant will start
-    an interactive changeset browser.
+    If no merges or revisions are provided, :hg:`transplant` will
+    start an interactive changeset browser.
 
     If a changeset application fails, you can fix the merge by hand
-    and then resume where you left off by calling hg transplant
-    --continue/-c.
+    and then resume where you left off by calling :hg:`transplant
+    --continue/-c`.
     '''
     def getremotechanges(repo, url):
         sourcerepo = ui.expandpath(url)
--- a/mercurial/commands.py	Tue May 18 16:24:14 2010 +0200
+++ b/mercurial/commands.py	Tue May 18 16:31:10 2010 +0200
@@ -24,7 +24,7 @@
     repository.
 
     The files will be added to the repository at the next commit. To
-    undo an add before that, see hg forget.
+    undo an add before that, see :hg:`forget`.
 
     If no names are given, add all files to the repository.
 
@@ -492,7 +492,7 @@
 
     List the repository's named branches, indicating which ones are
     inactive. If -c/--closed is specified, also list branches which have
-    been marked closed (see hg commit --close-branch).
+    been marked closed (see :hg:`commit --close-branch`).
 
     If -a/--active is specified, only show active branches. A branch
     is considered active if it contains repository heads.
@@ -724,8 +724,8 @@
     """commit the specified files or all outstanding changes
 
     Commit changes to the given files into the repository. Unlike a
-    centralized RCS, this operation is a local operation. See hg push
-    for a way to actively distribute your changes.
+    centralized RCS, this operation is a local operation. See
+    :hg:`push` for a way to actively distribute your changes.
 
     If a list of files is omitted, all changes reported by :hg:`status`
     will be committed.
@@ -792,7 +792,7 @@
     operation is recorded, but no copying is performed.
 
     This command takes effect with the next commit. To undo a copy
-    before that, see hg revert.
+    before that, see :hg:`revert`.
 
     Returns 0 on success, 1 if errors are encountered.
     """
@@ -1282,7 +1282,7 @@
     entire project history, and it does not delete them from the
     working directory.
 
-    To undo a forget before the next commit, see hg add.
+    To undo a forget before the next commit, see :hg:`add`.
 
     Returns 0 on success.
     """
@@ -1507,7 +1507,7 @@
     associated with the specified changesets are shown.
 
     If -c/--closed is specified, also show branch heads marked closed
-    (see hg commit --close-branch).
+    (see :hg:`commit --close-branch`).
 
     If STARTREV is specified, only those heads that are descendants of
     STARTREV will be displayed.
@@ -1914,7 +1914,7 @@
     text/plain body parts before first diff are added to commit
     message.
 
-    If the imported patch was generated by hg export, user and
+    If the imported patch was generated by :hg:`export`, user and
     description from patch override values from message headers and
     body. Values given on command line with -m/--message and -u/--user
     override these.
@@ -2500,10 +2500,10 @@
     -R is specified). By default, this does not update the copy of the
     project in the working directory.
 
-    Use hg incoming if you want to see what would have been added by a
-    pull at the time you issued this command. If you then decide to
-    add those changes to the repository, you should use pull -r X
-    where X is the last changeset listed by hg incoming.
+    Use :hg:`incoming` if you want to see what would have been added
+    by a pull at the time you issued this command. If you then decide
+    to add those changes to the repository, you should use :hg:`pull
+    -r X` where ``X`` is the last changeset listed by :hg:`incoming`.
 
     If SOURCE is omitted, the 'default' path will be used.
     See :hg:`help urls` for more information.
@@ -2596,8 +2596,8 @@
     The following table details the behavior of remove for different
     file states (columns) and option combinations (rows). The file
     states are Added [A], Clean [C], Modified [M] and Missing [!] (as
-    reported by hg status). The actions are Warn, Remove (from branch)
-    and Delete (from disk)::
+    reported by :hg:`status`). The actions are Warn, Remove (from
+    branch) and Delete (from disk)::
 
              A  C  M  !
       none   W  RD W  R
@@ -2606,7 +2606,7 @@
       -Af    R  R  R  R
 
     This command schedules the files to be removed at the next commit.
-    To undo a remove before that, see hg revert.
+    To undo a remove before that, see :hg:`revert`.
 
     Returns 0 on success, 1 if any warnings encountered.
     """
@@ -2661,7 +2661,7 @@
     operation is recorded, but no copying is performed.
 
     This command takes effect at the next commit. To undo a rename
-    before that, see hg revert.
+    before that, see :hg:`revert`.
 
     Returns 0 on success, 1 if errors are encountered.
     """
--- a/tests/test-help.out	Tue May 18 16:24:14 2010 +0200
+++ b/tests/test-help.out	Tue May 18 16:31:10 2010 +0200
@@ -241,7 +241,7 @@
     Schedule files to be version controlled and added to the repository.
 
     The files will be added to the repository at the next commit. To undo an
-    add before that, see hg forget.
+    add before that, see "hg forget".
 
     If no names are given, add all files to the repository.
 
@@ -262,7 +262,7 @@
     Schedule files to be version controlled and added to the repository.
 
     The files will be added to the repository at the next commit. To undo an
-    add before that, see hg forget.
+    add before that, see "hg forget".
 
     If no names are given, add all files to the repository.
 
@@ -314,7 +314,7 @@
     Schedule files to be version controlled and added to the repository.
 
     The files will be added to the repository at the next commit. To undo an
-    add before that, see hg forget.
+    add before that, see "hg forget".
 
     If no names are given, add all files to the repository.
 
@@ -335,7 +335,7 @@
     Schedule files to be version controlled and added to the repository.
 
     The files will be added to the repository at the next commit. To undo an
-    add before that, see hg forget.
+    add before that, see "hg forget".
 
     If no names are given, add all files to the repository.