Re: [PATCH v4 2/3] vimdiff: add tool documentation

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 10, 2021, 21:47 UTC
Message-ID: <xmqqilvwm8su.fsf@gitster.g>
In-Reply-To: <CAJDDKr77YQKJj15V52Rs=LPRMZVSkbpV8MWFDWNuYf4jqqCajg@mail.gmail.com>

David Aguilar <davvid@gmail.com> writes:

Show 18 quoted lines

>> +merge_cmd_help() {
>> +       echo "Run 'man git-mergetool--vimdiff' for details"
>> +       return 0
>> +}
>> +
>> +
>>  translate_merge_tool_path() {
>>         case "$1" in
>>         nvimdiff*)
>> --
>
>
> My understanding is that we prefer "git help" instead of "man" when
> providing hints.
>
> That means we should suggest something like this instead:
>
>         echo "Run 'git help mergetool--vimdiff' for details"

Thanks for pointing it out. Yes, not all platforms we support our documentation pages have the "man" command as the primary means to get to them.