From: Charles Bailey <charles@hashpling.org>
Date: Sat, 8 Mar 2008 20:47:06 +0000 (+0000)
Subject: merge-tool documentation: describe custom command usage
X-Git-Tag: v1.5.5-rc0~51
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=caa99829a24bc4decf86278c3478c88f564a795a;p=git.git

merge-tool documentation: describe custom command usage

The configuration variables for custom merge tools were documented
only in config.txt but there was no reference to the functionality in
git-mergetool.txt.

Signed-off-by: Charles Bailey <charles@hashpling.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
index ac8969cee..8ed44947e 100644
--- a/Documentation/git-mergetool.txt
+++ b/Documentation/git-mergetool.txt
@@ -37,6 +37,28 @@ configuration variable `mergetool.<tool>.path`. For example, you
 can configure the absolute path to kdiff3 by setting
 `mergetool.kdiff3.path`. Otherwise, `git mergetool` assumes the
 tool is available in PATH.
++
+Instead of running one of the known merge tool programs
+`git mergetool` can be customized to run an alternative program
+by specifying the command line to invoke in a configration
+variable `mergetool.<tool>.cmd`.
++
+When `git mergetool` is invoked with this tool (either through the
+`-t` or `--tool` option or the `merge.tool` configuration
+variable) the configured command line will be invoked with `$BASE`
+set to the name of a temporary file containing the common base for
+the merge, if available; `$LOCAL` set to the name of a temporary
+file containing the contents of the file on the current branch;
+`$REMOTE` set to the name of a temporary file containing the
+contents of the file to be merged, and `$MERGED` set to the name
+of the file to which the merge tool should write the result of the
+merge resolution.
++
+If the custom merge tool correctly indicates the success of a
+merge resolution with its exit code then the configuration
+variable `mergetool.<tool>.trustExitCode` can be set to `true`.
+Otherwise, `git mergetool` will prompt the user to indicate the
+success of the resolution after the custom tool has exited.
 
 Author
 ------