X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-mergetool.txt;h=31570b1e27af6a603df98868c627da08d91c17cc;hb=5e97f464df082d8f45e163bbf24341dceeafe89d;hp=83525609c6ff3e4d82c9e8021b3107517c682496;hpb=159e639e5bf24d78b22802934ae335413b2aa6ae;p=git.git diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index 83525609c..31570b1e2 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -7,17 +7,17 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts SYNOPSIS -------- -'git-mergetool' [--tool=] []... +'git mergetool' [--tool=] []... DESCRIPTION ----------- Use `git mergetool` to run one of several merge utilities to resolve -merge conflicts. It is typically run after linkgit:git-merge[1]. +merge conflicts. It is typically run after 'git-merge'. If one or more parameters are given, the merge tool program will be run to resolve differences on each file. If no names are -specified, `git mergetool` will run the merge tool program on every file +specified, 'git-mergetool' will run the merge tool program on every file with merge conflicts. OPTIONS @@ -27,23 +27,23 @@ OPTIONS Valid merge tools are: kdiff3, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff, ecmerge, and opendiff + -If a merge resolution program is not specified, `git mergetool` +If a merge resolution program is not specified, 'git-mergetool' will use the configuration variable `merge.tool`. If the -configuration variable `merge.tool` is not set, `git mergetool` +configuration variable `merge.tool` is not set, 'git-mergetool' will pick a suitable default. + You can explicitly provide a full path to the tool by setting the configuration variable `mergetool..path`. For example, you 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. + Instead of running one of the known merge tool programs -`git mergetool` can be customized to run an alternative program +'git-mergetool' can be customized to run an alternative program by specifying the command line to invoke in a configration variable `mergetool..cmd`. + -When `git mergetool` is invoked with this tool (either through the +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 @@ -57,7 +57,7 @@ merge resolution. If the custom merge tool correctly indicates the success of a merge resolution with its exit code then the configuration variable `mergetool..trustExitCode` can be set to `true`. -Otherwise, `git mergetool` will prompt the user to indicate the +Otherwise, 'git-mergetool' will prompt the user to indicate the success of the resolution after the custom tool has exited. Author