difftool docs: restore correct position of tool list

Commit Message

Adam Johnson Jan. 8, 2025, 11:35 p.m. UTC

From: Adam Johnson <[e-mail]>

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.
This patch restores the correct position of the included list.

Signed-off-by: Adam Johnson <[e-mail]>
---
    difftool docs: restore correct position of tool list

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1849%2Fadamchainz%2Faj%2Fgit-difftool-docs-fix-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1849/adamchainz/aj/git-difftool-docs-fix-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1849

 Documentation/config/diff.txt     | 2 --
 Documentation/config/difftool.txt | 2 ++
 2 files changed, 2 insertions(+), 2 deletions(-)


base-commit: a60673e9252b08d4eca90543b3729f4798b9aafd

Comments

Junio C Hamano Jan. 9, 2025, 4:46 p.m. UTC | #1

"Adam Johnson via GitGitGadget" <[e-mail]> writes:

> From: Adam Johnson <[e-mail]>
>
> 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

Patch

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[]
-
 `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[]
+
 difftool.<tool>.cmd::
 	Specify the command to invoke the specified diff tool.
 	The specified command is evaluated in shell with the following