Re: [PATCH] mergetool,difftool: Document --tool-help consistently

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 10, 2012, 15:04 UTC
Message-ID: <7vk3x6lreb.fsf@alter.siamese.dyndns.org>
In-Reply-To: <CAHGBnuMCLkALCCAp1MiwQ1J+TuUhD=4k3LTGP2BMrp1LThb=HQ@mail.gmail.com>

Sebastian Schuberth <sschuberth@gmail.com> writes:

Show 13 quoted lines

> On Fri, Aug 10, 2012 at 6:52 AM, David Aguilar <davvid@gmail.com> wrote:
>
>> Add an entry for --tool-help to the mergetool documentation.
>>
>> Move --tool-help in the difftool documentation so that it is
>> listed immediately after --tool so that it is easier to find.
>>
>> Signed-off-by: David Aguilar <davvid@gmail.com>
>
> Funny, I was doing almost the same thing in [1], so I obviously
> like it. Back then Junio found it "Meh" because "it already is
> mentioned in the description of --tool above", but I still think
> all available command line option should be listed as such.

Either way is fine by me. Even though I do not think it adds much value, there is no reason to hiding the option; it is not like we are discouraging the use of it.

Let's take the version with the description of --tool-help, then, and have it next to the description of --tool.

Thanks for sanity checking.

Show 11 quoted lines

>> --- a/Documentation/git-mergetool.txt
>> +++ b/Documentation/git-mergetool.txt
>> @@ -64,6 +64,9 @@ variable `mergetool.<tool>.trustExitCode` can be set to `true`.
>>  Otherwise, 'git mergetool' will prompt the user to indicate the
>>  success of the resolution after the custom tool has exited.
>>
>> +--tool-help::
>> +       Print a list of diff tools that may be used with `--tool`.
>> +
>
> This should say "list of merge tools", however.

Will amend while queuing.

Thanks.