Skip to content

Commit 17bae89

Browse files
phil-blaingitster
authored andcommitted
git.txt: correct stale 'GIT_EXTERNAL_DIFF' description
In fde97d8 (Update documentation to remove incorrect GIT_DIFF_OPTS example., 2006-11-27), the description of the 'GIT_EXTERNAL_DIFF' variable was moved from 'diff-format.txt' to 'git.txt', and the documentation was updated to remove a 'diff(1)' invocation since Git did not use an external diff program anymore by default. However, the description of 'GIT_EXTERNAL_DIFF' still mentions "instead of the diff invocation described above", which is confusing. Correct that outdated sentence. Also, link to git(1) in 'diff-generate-patch.txt' when GIT_DIFF_OPTS and GIT_EXTERNAL_DIFF are mentioned, so that users can easily know what these variables are about. Signed-off-by: Philippe Blain <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 47ae905 commit 17bae89

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

Documentation/diff-generate-patch.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ linkgit:git-diff-tree[1], or
1010
linkgit:git-diff-files[1]
1111
with the `-p` option produces patch text.
1212
You can customize the creation of patch text via the
13-
`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables.
13+
`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables
14+
(see linkgit:git[1]).
1415

1516
What the -p option produces is slightly different from the traditional
1617
diff format:

Documentation/git.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -543,8 +543,9 @@ Git Diffs
543543

544544
`GIT_EXTERNAL_DIFF`::
545545
When the environment variable `GIT_EXTERNAL_DIFF` is set, the
546-
program named by it is called, instead of the diff invocation
547-
described above. For a path that is added, removed, or modified,
546+
program named by it is called to generate diffs, and Git
547+
does not use its builtin diff machinery.
548+
For a path that is added, removed, or modified,
548549
`GIT_EXTERNAL_DIFF` is called with 7 parameters:
549550

550551
path old-file old-hex old-mode new-file new-hex new-mode

0 commit comments

Comments
 (0)