diff options
| author |  Jonathan Nieder <jrnieder@uchicago.edu> | 2008-06-30 01:09:04 -0500 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2008-07-01 17:20:15 -0700 |
| commit | b1889c36d85514e5e70462294c561a02c2edfe2b (patch) | |
| tree | 9a171d7e3fb8063c239a2c9c4dcec744a202de07 /Documentation/git-mergetool.txt | |
| parent | Documentation: prepare to be consistent about "git-" versus "git " (diff) | |
| download | tgif-b1889c36d85514e5e70462294c561a02c2edfe2b.tar.xz | |
Documentation: be consistent about "git-" versus "git "
Since the git-* commands are not installed in $(bindir), using
"git-command <parameters>" in examples in the documentation is
not a good idea. On the other hand, it is nice to be able to
refer to each command using one hyphenated word. (There is no
escaping it, anyway: man page names cannot have spaces in them.)
This patch retains the dash in naming an operation, command,
program, process, or action. Complete command lines that can
be entered at a shell (i.e., without options omitted) are
made to use the dashless form.
The changes consist only of replacing some spaces with hyphens
and vice versa. After a "s/ /-/g", the unpatched and patched
versions are identical.
Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-mergetool.txt')
| -rw-r--r-- | Documentation/git-mergetool.txt | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index 83525609c6..fc1b030026 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -7,7 +7,7 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts SYNOPSIS -------- -'git-mergetool' [--tool=<tool>] [<file>]... +'git mergetool' [--tool=<tool>] [<file>]... DESCRIPTION ----------- @@ -17,7 +17,7 @@ merge conflicts. It is typically run after linkgit:git-merge[1]. If one or more <file> parameters are given, the merge tool program will be run to resolve differences on each file. If no <file> 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.<tool>.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.<tool>.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.<tool>.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 |