Rev 5861: Fix some ReST typos in the configuration help and restore the workaround for dotted format names breaking sphinx. in file:///home/vila/src/bzr/bugs/782289-chm-sphinx/

[Vincent Ladeuil]

At file:///home/vila/src/bzr/bugs/782289-chm-sphinx/

------------------------------------------------------------
revno: 5861
revision-id: v.ladeuil+lp at free.fr-20110514131827-ua45hg7mwh0okwb3
parent: pqm at pqm.ubuntu.com-20110513165944-rv579ds1kciopi4n
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: 782289-chm-sphinx
timestamp: Sat 2011-05-14 15:18:27 +0200
message:
  Fix some ReST typos in the configuration help and restore the workaround for dotted format names breaking sphinx.
-------------- next part --------------
=== modified file 'bzrlib/commands.py'
--- a/bzrlib/commands.py	2011-04-19 04:37:48 +0000
+++ b/bzrlib/commands.py	2011-05-14 13:18:27 +0000
@@ -520,12 +520,13 @@
         # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
         # 20090319
         options = option.get_optparser(self.options()).format_option_help()
-        # XXX: According to the spec, ReST option lists actually don't support 
-        # options like --1.9 so that causes syntax errors (in Sphinx at least).
-        # As that pattern always appears in the commands that break, we trap
-        # on that and then format that block of 'format' options as a literal
-        # block.
-        if not plain and options.find('  --1.9  ') != -1:
+        # FIXME: According to the spec, ReST option lists actually don't
+        # support options like --1.14 so that causes syntax errors (in Sphinx
+        # at least).  As that pattern always appears in the commands that
+        # break, we trap on that and then format that block of 'format' options
+        # as a literal block. We use the most recent format still listed so we
+        # don't have to do that too often -- vila 20110514
+        if not plain and options.find('  --1.14  ') != -1:
             options = options.replace(' format:\n', ' format::\n\n', 1)
         if options.startswith('Options:'):
             result += ':' + options

=== modified file 'bzrlib/help_topics/en/configuration.txt'
--- a/bzrlib/help_topics/en/configuration.txt	2011-02-25 12:12:39 +0000
+++ b/bzrlib/help_topics/en/configuration.txt	2011-05-14 13:18:27 +0000
@@ -603,25 +603,25 @@
 executable may omit its path if it can be found on the PATH.
 
 The following markers can be used in the command-line to substitute filenames
-involved in the merge conflict:
-
-{base}      file.BASE
-{this}      file.THIS
-{other}     file.OTHER
-{result}    output file
-{this_temp} temp copy of file.THIS, used to overwrite output file if merge
-            succeeds.
-
-For example:
+involved in the merge conflict::
+
+  {base}      file.BASE
+  {this}      file.THIS
+  {other}     file.OTHER
+  {result}    output file
+  {this_temp} temp copy of file.THIS, used to overwrite output file if merge
+              succeeds.
+
+For example::
 
   bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
 
 bzr.default_mergetool
-~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 Specifies which external merge tool (as defined above) should be selected by
 default in tools such as ``bzr qconflicts``.
 
-For example:
+For example::
 
   bzr.default_mergetool = kdiff3

=== modified file 'doc/en/release-notes/bzr-2.4.txt'
--- a/doc/en/release-notes/bzr-2.4.txt	2011-05-13 14:02:14 +0000
+++ b/doc/en/release-notes/bzr-2.4.txt	2011-05-14 13:18:27 +0000
@@ -74,6 +74,10 @@
 
 .. Improved or updated documentation.
 
+* Restore the workaround for option names including dots (--1.14) which was
+  disabled when we stopped listing --1.9 as a format.
+  (Vincent Ladeuil, #782289)
+
 API Changes
 ***********
 

=== renamed file 'doc/en/user-reference/readme.txt' => 'doc/en/user-reference/README'