Rev 6565: Clarify why mergetool templates cannot be displayed by bzr config TEMPLATE in file:///home/vila/src/bzr/cleanup/mergetool-doc/

[Vincent Ladeuil]

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

------------------------------------------------------------
revno: 6565
revision-id: v.ladeuil+lp at free.fr-20120919100140-w72xcwrbvi3brkkw
parent: pqm at pqm.ubuntu.com-20120919091529-7npqgpvfroffuy8f
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: mergetool-doc
timestamp: Wed 2012-09-19 12:01:40 +0200
message:
  Clarify why mergetool templates cannot be displayed by bzr config TEMPLATE
-------------- next part --------------
=== modified file 'bzrlib/help_topics/en/configuration.txt'
--- a/bzrlib/help_topics/en/configuration.txt	2012-06-20 13:58:18 +0000
+++ b/bzrlib/help_topics/en/configuration.txt	2012-09-19 10:01:40 +0000
@@ -713,6 +713,21 @@
 
   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::
+
+  $ 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::
+
+  $ bzr config --all bzr.mergetool.kdiff3
+  branch:
+    bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
+
+
 bzr.default_mergetool
 ~~~~~~~~~~~~~~~~~~~~~