Rev 6566: Tone down ; ) in file:///home/vila/src/bzr/cleanup/mergetool-doc/

[Vincent Ladeuil]

At file:///home/vila/src/bzr/cleanup/mergetool-doc/

------------------------------------------------------------
revno: 6566
revision-id: v.ladeuil+lp at free.fr-20120919121000-1gxj7s5t1ckct9eg
parent: v.ladeuil+lp at free.fr-20120919100140-w72xcwrbvi3brkkw
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: mergetool-doc
timestamp: Wed 2012-09-19 14:10:00 +0200
message:
  Tone down ;)
-------------- next part --------------
=== modified file 'bzrlib/help_topics/en/configuration.txt'
--- a/bzrlib/help_topics/en/configuration.txt	2012-09-19 10:01:40 +0000
+++ b/bzrlib/help_topics/en/configuration.txt	2012-09-19 12:10:00 +0000
@@ -713,15 +713,18 @@
 
   bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
 
-Note that because mergetool configuration options are templates and that
-they use options that are never put into configuration files but provided by
-bzr itself during conflict resolutions, the following will (rightly) break::
+The markers above are not regular configuration options, they are provided
+explicitly during conflit resolutions (as opposed to configuration
+files). As such, when defining templates be careful of the following
+caveat::
 
   $ bzr config bzr.mergetool.kdiff3='kdiff3 {base} {this} {other} -o {result}'
   $ bzr config bzr.mergetool.kdiff3
   bzr: ERROR: Option base is not defined while expanding "kdiff3 {base} {this} {other} -o {result}".
 
-Instead, to disable option expansion in this particular case, one should use::
+Since ``bzr config`` is used here outside of any conflict resolution, there
+is no way for the markers to be defined. Instead, to disable option
+expansion in this particular case, one should use::
 
   $ bzr config --all bzr.mergetool.kdiff3
   branch: