mirror of
https://github.com/git/git
synced 2024-09-13 05:14:36 +00:00
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>
This commit is contained in:
parent
bbdfbc4b01
commit
caa99829a2
|
@ -37,6 +37,28 @@ configuration variable `mergetool.<tool>.path`. For example, you
|
||||||
can configure the absolute path to kdiff3 by setting
|
can configure the absolute path to kdiff3 by setting
|
||||||
`mergetool.kdiff3.path`. Otherwise, `git mergetool` assumes the
|
`mergetool.kdiff3.path`. Otherwise, `git mergetool` assumes the
|
||||||
tool is available in PATH.
|
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
|
Author
|
||||||
------
|
------
|
||||||
|
|
Loading…
Reference in a new issue