path: root/Documentation/git-mergetool.txt
diff options
authorCharles Bailey <>2008-03-08 20:47:06 (GMT)
committerJunio C Hamano <>2008-03-08 21:22:55 (GMT)
commitcaa99829a24bc4decf86278c3478c88f564a795a (patch)
tree2b7641d62aab7aeeba8fd108a5d4a97dc0f20c2f /Documentation/git-mergetool.txt
parentbbdfbc4b01b38489a0c171bc70c89e017c759cdc (diff)
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 <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-mergetool.txt')
1 files changed, 22 insertions, 0 deletions
diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
index ac8969c..8ed4494 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.