Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

git.txt: correct stale 'GIT_EXTERNAL_DIFF' description #718

Closed

Conversation

phil-blain
Copy link

@phil-blain phil-blain commented Sep 1, 2020

CC: Sean Estabrooks seanlkml@sympatico.ca

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 <levraiphilippeblain@gmail.com>
@phil-blain
Copy link
Author

/submit

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 1, 2020

Submitted as pull.718.git.1598966412371.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git pr-718/phil-blain/git-external-diff-wording-v1

To fetch this version to local tag pr-718/phil-blain/git-external-diff-wording-v1:

git fetch --no-tags https://github.com/gitgitgadget/git tag pr-718/phil-blain/git-external-diff-wording-v1

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 1, 2020

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:

> diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt
> index e8ed6470fb..b10ff4caa6 100644
> --- a/Documentation/diff-generate-patch.txt
> +++ b/Documentation/diff-generate-patch.txt
> @@ -10,7 +10,8 @@ linkgit:git-diff-tree[1], or
>  linkgit:git-diff-files[1]
>  with the `-p` option produces patch text.
>  You can customize the creation of patch text via the
> -`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables.
> +`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables
> +(see linkgit:git[1]).
>  
>  What the -p option produces is slightly different from the traditional
>  diff format:
> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index 2fc92586b5..98bdf0983c 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -551,8 +551,9 @@ Git Diffs
>  
>  `GIT_EXTERNAL_DIFF`::
>  	When the environment variable `GIT_EXTERNAL_DIFF` is set, the
> -	program named by it is called, instead of the diff invocation
> -	described above.  For a path that is added, removed, or modified,
> +	program named by it is called to generate diffs, and Git
> +	does not use its builtin diff machinery.
> +	For a path that is added, removed, or modified,
>  	`GIT_EXTERNAL_DIFF` is called with 7 parameters:

Excellent.  Thanks.   Will queue.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 1, 2020

This branch is now known as pb/doc-external-diff-env.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 1, 2020

This patch series was integrated into seen via git@4443015.

@gitgitgadget gitgitgadget bot added the seen label Sep 1, 2020
@gitgitgadget
Copy link

gitgitgadget bot commented Sep 2, 2020

This patch series was integrated into seen via git@c03387a.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 2, 2020

This patch series was integrated into seen via git@45a6f94.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 2, 2020

This patch series was integrated into next via git@a789fe3.

@gitgitgadget gitgitgadget bot added the next label Sep 2, 2020
@gitgitgadget
Copy link

gitgitgadget bot commented Sep 3, 2020

This patch series was integrated into seen via git@cd332b2.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 3, 2020

This patch series was integrated into next via git@cd332b2.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 3, 2020

This patch series was integrated into master via git@cd332b2.

@gitgitgadget gitgitgadget bot added the master label Sep 3, 2020
@gitgitgadget gitgitgadget bot closed this Sep 3, 2020
@gitgitgadget
Copy link

gitgitgadget bot commented Sep 3, 2020

Closed via cd332b2.

@phil-blain phil-blain deleted the git-external-diff-wording branch October 12, 2020 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant