difftool: fix documentation problems
This patch makes the difftool docs always refer to the git-difftool script using the dashed form of the name. Only command examples use the non-dashed form now. Signed-off-by: David Aguilar <davvid@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
9003dd4027
commit
507cfcbd81
@ -4,7 +4,7 @@
|
|||||||
# This is a wrapper around the GIT_EXTERNAL_DIFF-compatible
|
# This is a wrapper around the GIT_EXTERNAL_DIFF-compatible
|
||||||
# git-difftool-helper script. This script exports
|
# git-difftool-helper script. This script exports
|
||||||
# GIT_EXTERNAL_DIFF and GIT_PAGER for use by git, and
|
# GIT_EXTERNAL_DIFF and GIT_PAGER for use by git, and
|
||||||
# GIT_NO_PROMPT and GIT_MERGE_TOOL for use by git-difftool-helper.
|
# GIT_DIFFTOOL_NO_PROMPT and GIT_MERGE_TOOL for use by git-difftool-helper.
|
||||||
# Any arguments that are unknown to this script are forwarded to 'git diff'.
|
# Any arguments that are unknown to this script are forwarded to 'git diff'.
|
||||||
|
|
||||||
use strict;
|
use strict;
|
||||||
@ -18,8 +18,7 @@ my $DIR = abs_path(dirname($0));
|
|||||||
sub usage
|
sub usage
|
||||||
{
|
{
|
||||||
print << 'USAGE';
|
print << 'USAGE';
|
||||||
|
usage: git difftool [--tool=<tool>] [--no-prompt] ["git diff" options]
|
||||||
usage: git difftool [--no-prompt] [--tool=tool] ["git diff" options]
|
|
||||||
USAGE
|
USAGE
|
||||||
exit 1;
|
exit 1;
|
||||||
}
|
}
|
||||||
|
@ -11,16 +11,16 @@ SYNOPSIS
|
|||||||
|
|
||||||
DESCRIPTION
|
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,
|
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
|
situations such as when preparing commits or comparing changes against
|
||||||
the index.
|
the index.
|
||||||
|
|
||||||
'git difftool' is a frontend to 'git diff' and accepts the same
|
'git difftool' is a frontend to 'git diff' and accepts the same
|
||||||
arguments and options.
|
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
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
@ -30,7 +30,7 @@ OPTIONS
|
|||||||
Valid merge tools are:
|
Valid merge tools are:
|
||||||
kdiff3, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff, ecmerge, and opendiff
|
kdiff3, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff, ecmerge, and opendiff
|
||||||
+
|
+
|
||||||
If a merge resolution program is not specified, 'git difftool'
|
If a merge resolution program is not specified, 'git-difftool'
|
||||||
will use the configuration variable `merge.tool`. If the
|
will use the configuration variable `merge.tool`. If the
|
||||||
configuration variable `merge.tool` is not set, 'git difftool'
|
configuration variable `merge.tool` is not set, 'git difftool'
|
||||||
will pick a suitable default.
|
will pick a suitable default.
|
||||||
@ -38,15 +38,15 @@ will pick a suitable default.
|
|||||||
You can explicitly provide a full path to the tool by setting the
|
You can explicitly provide a full path to the tool by setting the
|
||||||
configuration variable `mergetool.<tool>.path`. For example, you
|
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 difftool' assumes the
|
`mergetool.kdiff3.path`. Otherwise, 'git-difftool' assumes the
|
||||||
tool is available in PATH.
|
tool is available in PATH.
|
||||||
+
|
+
|
||||||
Instead of running one of the known merge tool programs,
|
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
|
by specifying the command line to invoke in a configuration
|
||||||
variable `mergetool.<tool>.cmd`.
|
variable `mergetool.<tool>.cmd`.
|
||||||
+
|
+
|
||||||
When 'git difftool' is invoked with this tool (either through the
|
When 'git-difftool' is invoked with this tool (either through the
|
||||||
`-t` or `--tool` option or the `merge.tool` configuration variable)
|
`-t` or `--tool` option or the `merge.tool` configuration variable)
|
||||||
the configured command line will be invoked with the following
|
the configured command line will be invoked with the following
|
||||||
variables available: `$LOCAL` is set to the name of the temporary
|
variables available: `$LOCAL` is set to the name of the temporary
|
||||||
@ -56,7 +56,7 @@ of the diff post-image. `$BASE` is provided for compatibility
|
|||||||
with custom merge tool commands and has the same value as `$LOCAL`.
|
with custom merge tool commands and has the same value as `$LOCAL`.
|
||||||
|
|
||||||
--no-prompt::
|
--no-prompt::
|
||||||
Do not prompt before launching a merge tool.
|
Do not prompt before launching a diff tool.
|
||||||
|
|
||||||
CONFIG VARIABLES
|
CONFIG VARIABLES
|
||||||
----------------
|
----------------
|
||||||
@ -81,13 +81,13 @@ See the `--tool=<tool>` option above for more details.
|
|||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
linkgit:git-diff[7]::
|
linkgit:git-diff[1]::
|
||||||
Show changes between commits, commit and working tree, etc
|
Show changes between commits, commit and working tree, etc
|
||||||
|
|
||||||
linkgit:git-mergetool[1]::
|
linkgit:git-mergetool[1]::
|
||||||
Run merge conflict resolution tools to resolve merge conflicts
|
Run merge conflict resolution tools to resolve merge conflicts
|
||||||
|
|
||||||
linkgit:git-config[7]::
|
linkgit:git-config[1]::
|
||||||
Get and set repository or global options
|
Get and set repository or global options
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user