changeset 21527:1f05a7bcde50

help: add local/other description to merge tool description Adds a more detailed description of what 'local' and 'other' mean to the merge tool documentation.
author Durham Goode <durham@fb.com>
date Fri, 16 May 2014 13:15:07 -0700
parents 3b40e32e88c3
children 32b9bbca2052
files mercurial/help/config.txt
diffstat 1 files changed, 7 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/help/config.txt	Thu May 08 16:55:56 2014 -0700
+++ b/mercurial/help/config.txt	Fri May 16 13:15:07 2014 -0700
@@ -843,7 +843,13 @@
 ``args``
   The arguments to pass to the tool executable. You can refer to the
   files being merged as well as the output file through these
-  variables: ``$base``, ``$local``, ``$other``, ``$output``.
+  variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
+  of ``$local`` and ``$other`` can vary depending on which action is being
+  performed. During and update or merge, ``$local`` represents the original
+  state of the file, while ``$other`` represents the commit you are updating
+  to or the commit you are merging with. During a rebase ``$local``
+  represents the destination of the rebase, and ``$other`` represents the
+  commit being rebased.
   Default: ``$local $base $other``
 
 ``premerge``