[PATCH] docs: don't use :hg: at the beginning of lines in notes (issue3397)

Mads Kiilerich mads at kiilerich.com
Wed Apr 25 16:32:57 CDT 2012


# HG changeset patch
# User Mads Kiilerich <mads at kiilerich.com>
# Date 1335389334 -7200
# Branch stable
# Node ID c7fce99285bcba5491225207012b33ec3762322c
# Parent  e3c7ca15cde24f7e1ef5018fcfd902f4d6c95adc
docs: don't use :hg: at the beginning of lines in notes (issue3397)

It seem like docutils 0.8 interpret ':hg:`command`' roles at the beginning of
indented lines in '.. note::' directives as a field that is an invalid argument
to the directive. It fails with 'Error in "note" directive: invalid option
block.' Docutils 0.7 accepted this arguably incorrect markup.

Reflowing the text makes the problem go away. A leading '\ ' could perhaps also
be used to mask the problem.

diff --git a/mercurial/help/patterns.txt b/mercurial/help/patterns.txt
--- a/mercurial/help/patterns.txt
+++ b/mercurial/help/patterns.txt
@@ -7,8 +7,8 @@
 Alternate pattern notations must be specified explicitly.
 
 .. note::
-  Patterns specified in ``.hgignore`` are not rooted. Please see
-  :hg:`help hgignore` for details.
+  Patterns specified in ``.hgignore`` are not rooted. 
+  Please see :hg:`help hgignore` for details.
 
 To use a plain path name without any pattern matching, start it with
 ``path:``. These path names must completely match starting at the


More information about the Mercurial-devel mailing list