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>
David Aguilar committed
Jan 18, 2009 at 21:27 UTC
507cfcbd81196e14053bcd25735aaefabd99395d
2 files changed
+12
-13
contrib/difftool/git-difftool
+2
-3
@@ -4,7 +4,7 @@
4
# This is a wrapper around the GIT_EXTERNAL_DIFF-compatible
5
# git-difftool-helper script. This script exports
6
# GIT_EXTERNAL_DIFF and GIT_PAGER for use by git, and
7
-# GIT_NO_PROMPT and GIT_MERGE_TOOL for use by git-difftool-helper.
7
+# GIT_DIFFTOOL_NO_PROMPT and GIT_MERGE_TOOL for use by git-difftool-helper.
8
# Any arguments that are unknown to this script are forwarded to 'git diff'.
9
10
use strict;
@@ -18,8 +18,7 @@ my $DIR = abs_path(dirname($0));
18
sub usage
19
{
20
print << 'USAGE';
21
-
22
-usage: git difftool [--no-prompt] [--tool=tool] ["git diff" options]
21
+usage: git difftool [--tool=<tool>] [--no-prompt] ["git diff" options]
22
USAGE
23
exit 1;
24
}
contrib/difftool/git-difftool.txt
+10
-10
@@ -11,16 +11,16 @@ SYNOPSIS
11
12
DESCRIPTION
13
-----------
14
-'git difftool' is a git command that allows you to compare and edit files
14
+'git-difftool' is a git command that allows you to compare and edit files
15
between revisions using common merge tools. At its most basic level,
16
-'git difftool' does what 'git mergetool' does but its use is for non-merge
16
+'git-difftool' does what 'git-mergetool' does but its use is for non-merge
17
situations such as when preparing commits or comparing changes against
18
the index.
19
20
'git difftool' is a frontend to 'git diff' and accepts the same
21
arguments and options.
22
23
-See linkgit:git-diff[7] for the full list of supported options.
23
+See linkgit:git-diff[1] for the full list of supported options.
24
25
OPTIONS
26
-------
@@ -30,7 +30,7 @@ OPTIONS
30
Valid merge tools are:
31
kdiff3, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff, ecmerge, and opendiff
32
+
33
-If a merge resolution program is not specified, 'git difftool'
33
+If a merge resolution program is not specified, 'git-difftool'
34
will use the configuration variable `merge.tool`. If the
35
configuration variable `merge.tool` is not set, 'git difftool'
36
will pick a suitable default.
@@ -38,15 +38,15 @@ will pick a suitable default.
38
You can explicitly provide a full path to the tool by setting the
39
configuration variable `mergetool.<tool>.path`. For example, you
40
can configure the absolute path to kdiff3 by setting
41
-`mergetool.kdiff3.path`. Otherwise, 'git difftool' assumes the
41
+`mergetool.kdiff3.path`. Otherwise, 'git-difftool' assumes the
42
tool is available in PATH.
43
+
44
Instead of running one of the known merge tool programs,
45
-'git difftool' can be customized to run an alternative program
45
+'git-difftool' can be customized to run an alternative program
46
by specifying the command line to invoke in a configuration
47
variable `mergetool.<tool>.cmd`.
48
+
49
-When 'git difftool' is invoked with this tool (either through the
49
+When 'git-difftool' is invoked with this tool (either through the
50
`-t` or `--tool` option or the `merge.tool` configuration variable)
51
the configured command line will be invoked with the following
52
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
56
with custom merge tool commands and has the same value as `$LOCAL`.
57
58
--no-prompt::
59
- Do not prompt before launching a merge tool.
59
+ Do not prompt before launching a diff tool.
60
61
CONFIG VARIABLES
62
----------------
@@ -81,13 +81,13 @@ See the `--tool=<tool>` option above for more details.
81
82
SEE ALSO
83
--------
84
-linkgit:git-diff[7]::
84
+linkgit:git-diff[1]::
85
Show changes between commits, commit and working tree, etc
86
87
linkgit:git-mergetool[1]::
88
Run merge conflict resolution tools to resolve merge conflicts
89
90
-linkgit:git-config[7]::
90
+linkgit:git-config[1]::
91
Get and set repository or global options
92
93