Re: [PATCH v8 5/5] mergetools: add tools description to `git help config`

[Philippe Blain <levraiphilippeblain@gmail.com>]

Hi Fernando,

Le 2022-03-29 à 18:44, Fernando Ramos a écrit :
> Now the output of `git help config` not only shows the name of each
> tool (as before) but also a short description (as it is the case when
> running `git mergetool --tool-help` or ` git difftool --tool-help`)
> 
> Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>

This commit is authored by you but is missing your sign off. 
Also, I did not give my sign-off on this patch (that can't be assumed, 
it always has to be expressively given).

When people provide "in mail" diffs like I did in [1] and [2], it's usually meant
to be squashed into a commit of the series. In this case I think it would
be best squashed in 3/4, since as I explained in [3], the description of
each merge tool is already included in the 'git config' documentation after your
3/4, the below patch to the Makefile just makes it an Asciidoc "description list"
(and formats the merge tool names between backticks) instead of a plain list
as it was before.

Granted, after 3/4 only vimdiff and friends have a description, but that can be 
explained in the commit message, and the rest of the descriptions are added in 4/4.

> ---
>  Documentation/Makefile | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 1eb9192dae..faed285462 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -302,12 +302,12 @@ $(mergetools_txt): mergetools-list.made
>  
>  mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
>  	$(QUIET_GEN) \
> -	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
> +	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && TOOL_MODE=diff && \
>  		. ../git-mergetool--lib.sh && \
> -		show_tool_names can_diff "* " || :' >mergetools-diff.txt && \
> -	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
> +		show_tool_names can_diff' | sed -e "s/\([a-z0-9]*\)/\`\1\`;;/" >mergetools-diff.txt && \
> +	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && TOOL_MODE=merge && \
>  		. ../git-mergetool--lib.sh && \
> -		show_tool_names can_merge "* " || :' >mergetools-merge.txt && \
> +		show_tool_names can_merge' | sed -e "s/\([a-z0-9]*\)/\`\1\`;;/" >mergetools-merge.txt && \
>  	date >$@
>  
>  TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON):$(ASCIIDOC_HTML):$(ASCIIDOC_DOCBOOK))
> 

Cheers,

Philippe.

[1] https://lore.kernel.org/git/1363db57-74de-226a-468f-69feffde6ba5@gmail.com/
[2] https://lore.kernel.org/git/d0a0d00b-5c1a-4a0c-a91c-b03403578f80@gmail.com/
[3] https://lore.kernel.org/git/f56a7a0b-8525-c4cc-7bc7-5ac4bba59206@gmail.com/