git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: David Aguilar <davvid@gmail.com>
Cc: "Fernando Ramos" <greenfoo@u92.eu>,
	"Git Mailing List" <git@vger.kernel.org>,
	"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	"Eric Sunshine" <sunshine@sunshineco.com>,
	"Seth House" <seth@eseth.com>,
	levraiphilippeblain@gmail.com, rogi@skylittlesystem.org
Subject: Re: [PATCH v4 2/3] vimdiff: add tool documentation
Date: Fri, 10 Dec 2021 13:47:29 -0800	[thread overview]
Message-ID: <xmqqilvwm8su.fsf@gitster.g> (raw)
In-Reply-To: <CAJDDKr77YQKJj15V52Rs=LPRMZVSkbpV8MWFDWNuYf4jqqCajg@mail.gmail.com> (David Aguilar's message of "Thu, 9 Dec 2021 18:58:58 -0800")

David Aguilar <davvid@gmail.com> writes:

>> +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.

  reply	other threads:[~2021-12-10 21:47 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-04  9:03 [PATCH v4 0/3] vimdiff: new implementation with layout support Fernando Ramos
2021-12-04  9:03 ` [PATCH v4 1/3] " Fernando Ramos
2021-12-04  9:03 ` [PATCH v4 2/3] vimdiff: add tool documentation Fernando Ramos
2021-12-10  2:58   ` David Aguilar
2021-12-10 21:47     ` Junio C Hamano [this message]
2021-12-11 10:46     ` Fernando Ramos
2022-01-04 20:38       ` Fernando Ramos
2021-12-04  9:03 ` [PATCH v4 3/3] vimdiff: integrate layout tests in the unit tests framework ('t' folder) Fernando Ramos

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqilvwm8su.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=avarab@gmail.com \
    --cc=davvid@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=greenfoo@u92.eu \
    --cc=levraiphilippeblain@gmail.com \
    --cc=rogi@skylittlesystem.org \
    --cc=seth@eseth.com \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).