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

From: Philippe Blain <levraiphilippeblain@gmail.com>
Date: Mar 30, 2022, 18:45 UTC
Message-ID: <de847041-acad-2a01-6a4f-36ed7318e01c@gmail.com>
In-Reply-To: <YkSij31hyi29g7v2@zacax395.localdomain>

Hi Fernando,

Le 2022-03-30 à 14:33, Fernando Ramos a écrit :

Show 9 quoted lines

>> 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).
> 
> I see, sorry. As this patch is a verbatim copy of the one you provided in the
> last message I thought it was not appropriate to put my name on it (as it does
> not contain any line created by me)... but now I know that in these cases the
> right thing to do is to squash into the commit being commented on and add a
> "Helped-by:" note. Right?

Yes, right. :)

Show 6 quoted lines

> 
> I'll fix this in v9.
> 
> Just to double check, please confirm this is what you want me to do:
> 
>   1. Squash 5/5 into  3/5

yes.

Show 5 quoted lines

> 
>   2. Update the commit message to:
> 
>      2.1 Explain that the description is also added to the output of `git help
>          config`

Yes. For example, this is how I would phrase it, be free to copy (maybe as the second-to-last paragraph?):

Note that the function 'show_tool_names', used in the implmentation of 'git mergetool --tool-help', is also used in Documentation/Makefile to generate the list of allowed values for the configuration variables '{diff,merge}.{gui,}tool'. Adjust the rule so its output is an Asciidoc "description list" instead of a plain list, with the tool name as the item and the newly added tool description as the description.

> 
>      2.2 Remove your name from "Signed-off-by:"
> 
>      2.3 Keep you name in "Helped-by:"

yes and yes.

Show 6 quoted lines

> 
> Thanks!
> 
> 
> PS: I must confess this whole process of sending patches to the git mailing
> list brings me back memories from "Asterix: The 12 Tasks" [1] :) :) :)

Yes, it can be hard. I prefer using Gitgitgadget most of the time [1].

[1] https://gitgitgadget.github.io/