contrib/difftool: use a separate config namespace for difftool commands

[git.git] / contrib / difftool / git-difftool.txt

diff --git a/contrib/difftool/git-difftool.txt b/contrib/difftool/git-difftool.txt
index 3940c7057c74b03506d9fa009b1a5bfce927045b..2b7bc03ec3f63ce8bfe4ba8c00af9ab807e6cedf 100644 (file)
--- a/contrib/difftool/git-difftool.txt
+++ b/contrib/difftool/git-difftool.txt
@@ -11,16 +11,16 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-'git difftool' is a git command that allows you to compare and edit files
+'git-difftool' is a git command that allows you to compare and edit files
 between revisions using common merge tools.  At its most basic level,
-'git difftool' does what 'git mergetool' does but its use is for non-merge
+'git-difftool' does what 'git-mergetool' does but its use is for non-merge
 situations such as when preparing commits or comparing changes against
 the index.
 
 'git difftool' is a frontend to 'git diff' and accepts the same
 arguments and options.
 
-See linkgit:git-diff[7] for the full list of supported options.
+See linkgit:git-diff[1] for the full list of supported options.
 
 OPTIONS
 -------
@@ -28,26 +28,27 @@ OPTIONS
 --tool=<tool>::
        Use the merge resolution program specified by <tool>.
        Valid merge tools are:
-       kdiff3, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff, ecmerge, and opendiff
+       kdiff3, kompare, tkdiff, meld, xxdiff, emerge,
+       vimdiff, gvimdiff, ecmerge, and opendiff
 +
-If a merge resolution program is not specified, 'git difftool'
-will use the configuration variable `merge.tool`.  If the
-configuration variable `merge.tool` is not set, 'git difftool'
+If a merge resolution program is not specified, 'git-difftool'
+will use the configuration variable `diff.tool`.  If the
+configuration variable `diff.tool` is not set, 'git-difftool'
 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
+configuration variable `difftool.<tool>.path`. For example, you
 can configure the absolute path to kdiff3 by setting
-`mergetool.kdiff3.path`. Otherwise, 'git difftool' assumes the
+`difftool.kdiff3.path`. Otherwise, 'git-difftool' assumes the
 tool is available in PATH.
 +
 Instead of running one of the known merge tool programs,
-'git difftool' can be customized to run an alternative program
+'git-difftool' can be customized to run an alternative program
 by specifying the command line to invoke in a configuration
-variable `mergetool.<tool>.cmd`.
+variable `difftool.<tool>.cmd`.
 +
-When 'git difftool' is invoked with this tool (either through the
-`-t` or `--tool` option or the `merge.tool` configuration variable)
+When 'git-difftool' is invoked with this tool (either through the
+`-t` or `--tool` option or the `diff.tool` configuration variable)
 the configured command line will be invoked with the following
 variables available: `$LOCAL` is set to the name of the temporary
 file containing the contents of the diff pre-image and `$REMOTE`
@@ -56,38 +57,38 @@ of the diff post-image.  `$BASE` is provided for compatibility
 with custom merge tool commands and has the same value as `$LOCAL`.
 
 --no-prompt::
-       Do not prompt before launching a merge tool.
+       Do not prompt before launching a diff tool.
 
 CONFIG VARIABLES
 ----------------
-merge.tool::
-       The default merge tool to use.
-+
-See the `--tool=<tool>` option above for more details.
+'git-difftool' falls back to 'git-mergetool' config variables when the
+difftool equivalents have not been defined.
 
-merge.keepBackup::
-       The original, unedited file content can be saved to a file with
-       a `.orig` extension.  Defaults to `true` (i.e. keep the backup files).
+diff.tool::
+       The default merge tool to use.
 
-mergetool.<tool>.path::
+difftool.<tool>.path::
        Override the path for the given tool.  This is useful in case
        your tool is not in the PATH.
 
-mergetool.<tool>.cmd::
+difftool.<tool>.cmd::
        Specify the command to invoke the specified merge tool.
 +
 See the `--tool=<tool>` option above for more details.
 
+merge.keepBackup::
+       The original, unedited file content can be saved to a file with
+       a `.orig` extension.  Defaults to `true` (i.e. keep the backup files).
 
 SEE ALSO
 --------
-linkgit:git-diff[7]::
+linkgit:git-diff[1]::
         Show changes between commits, commit and working tree, etc
 
 linkgit:git-mergetool[1]::
        Run merge conflict resolution tools to resolve merge conflicts
 
-linkgit:git-config[7]::
+linkgit:git-config[1]::
         Get and set repository or global options