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

difftool docs: restore correct position of tool list #1849

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

adamchainz
Copy link

CC: Ævar Arnfjörð Bjarmason [email protected], Matheus Tavares [email protected]

2a9dfdf (difftool docs: de-duplicate configuration sections, 2022-09-07)
moved the difftool documentation, but missed moving this "include" line that
includes the generated list of diff tools, as referenced in the moved text.
This patch restores the correct position of the included list.

Signed-off-by: Adam Johnson <[email protected]>
@adamchainz
Copy link
Author

/preview

Copy link

gitgitgadget bot commented Jan 8, 2025

Preview email sent as [email protected]

@adamchainz
Copy link
Author

/submit

Copy link

gitgitgadget bot commented Jan 8, 2025

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1849/adamchainz/aj/git-difftool-docs-fix-v1

To fetch this version to local tag pr-1849/adamchainz/aj/git-difftool-docs-fix-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1849/adamchainz/aj/git-difftool-docs-fix-v1

Copy link

gitgitgadget bot commented Jan 9, 2025

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

"Adam Johnson via GitGitGadget" <[email protected]> writes:

> From: Adam Johnson <[email protected]>
>
> 2a9dfdf260 (difftool docs: de-duplicate configuration sections, 2022-09-07)
> moved the difftool documentation, but missed moving this "include" line that
> includes the generated list of diff tools, as referenced in the moved text.

Thanks for a very clearly written problem description.

> diff --git a/Documentation/config/diff.txt b/Documentation/config/diff.txt
> index fdae13a2122..1135a62a0ad 100644
> --- a/Documentation/config/diff.txt
> +++ b/Documentation/config/diff.txt
> @@ -218,8 +218,6 @@ endif::git-diff[]
>  	Set this option to `true` to make the diff driver cache the text
>  	conversion outputs.  See linkgit:gitattributes[5] for details.
>  
> -include::{build_dir}/mergetools-diff.txt[]
> -

Above this include, there was an entry for diff.guitool, and this
generated file was to enumerate possible values for the
configuration.

>  `diff.indentHeuristic`::
>  	Set this option to `false` to disable the default heuristics
>  	that shift diff hunk boundaries to make patches easier to read.
> diff --git a/Documentation/config/difftool.txt b/Documentation/config/difftool.txt
> index 447c40d85a2..6cd47331a91 100644
> --- a/Documentation/config/difftool.txt
> +++ b/Documentation/config/difftool.txt
> @@ -13,6 +13,8 @@ diff.guitool::
>  	and requires that a corresponding difftool.<guitool>.cmd variable
>  	is defined.
>  
> +include::{build_dir}/mergetools-diff.txt[]
> +

And the list now sits at the right place.

Will queue.  Thanks.

>  difftool.<tool>.cmd::
>  	Specify the command to invoke the specified diff tool.
>  	The specified command is evaluated in shell with the following
>
> base-commit: a60673e9252b08d4eca90543b3729f4798b9aafd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant