git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: Maxim Belsky via GitGitGadget <gitgitgadget@gmail.com>,
	git@vger.kernel.org, Max Belsky <public.belsky@gmail.com>
Subject: Re: [PATCH 1/1] doc: Change zsh git completion file name
Date: Fri, 11 Oct 2019 14:57:42 +0900	[thread overview]
Message-ID: <xmqqmue7hlih.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <nycvar.QRO.7.76.6.1910102310260.46@tvgsbejvaqbjf.bet> (Johannes Schindelin's message of "Thu, 10 Oct 2019 23:12:41 +0200 (CEST)")

Johannes Schindelin <Johannes.Schindelin@gmx.de> writes:

> On Thu, 10 Oct 2019, Maxim Belsky via GitGitGadget wrote:
>
>> From: Maxim Belsky <public.belsky@gmail.com>
>>
>> Signed-off-by: Maxim Belsky <public.belsky@gmail.com>
>
> I totally agree with the patch, but only because I read a couple of
> reports that users were struggling with this. Maybe add a couple of
> reference points to the commit message, to describe how easy it is to
> miss the fact that it needs to be a _file_, not a directory, and also
> describe how `zsh` tells you that there is a problem (even if it does
> not report a problem, that's a valuable piece of information for the
> commit message).

After reading the updated text, and then hearing many people cannot
get if the existing reference to ~/.zsh/_git is about a directory
(to which this should be added as one of the files in it) or a file,
I doubt that the updated text is clear enough for these people.

>> -# The recommended way to install this script is to copy to '~/.zsh/_git', and
>> -# then add the following to your ~/.zshrc file:
>> +# The recommended way to install this script is to copy to
>> +# '~/.zsh/.git-completion.zsh', and then add the following to your ~/.zshrc
>> +# file:

Perhaps making it absolutely clear by risking to be overly verbose,
like so?

    The recommended way to install this script is to make a copy of it
    in ~/.zsh/ directory as ~/.zsh/git-completion.zsh and then ...

If my attempt to be overly verbose and absolutely clear above is
giving a wrong piece of advice, then that would be an indication
that the original nor the updated text is clear enough, as they are
the primary sources of information on this matter I used to come up
with the suggestion ;-)

>>  #
>>  #  fpath=(~/.zsh $fpath)
>>
>> --
>> gitgitgadget
>>

  reply	other threads:[~2019-10-11  5:57 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-10 16:56 [PATCH 0/1] doc: Add a note about ~/.zsh/_git file Max Belsky via GitGitGadget
2019-10-10 16:56 ` [PATCH 1/1] doc: Change zsh git completion file name Maxim Belsky via GitGitGadget
2019-10-10 21:12   ` Johannes Schindelin
2019-10-11  5:57     ` Junio C Hamano [this message]
2019-10-11 17:54 ` [PATCH v2 0/1] doc: Add a note about ~/.zsh/_git file Max Belsky via GitGitGadget
2019-10-11 17:54   ` [PATCH v2 1/1] doc: Change zsh git completion file name Maxim Belsky via GitGitGadget
2019-10-12  1:35     ` Junio C Hamano
2019-10-14 23:44     ` SZEDER Gábor
2019-10-15  2:07       ` Junio C Hamano
2020-10-25  3:40       ` Felipe Contreras
2019-10-15 18:48   ` [PATCH v3 0/1] doc: Add a note about ~/.zsh/_git file Max Belsky via GitGitGadget
2019-10-15 18:48     ` [PATCH v3 1/1] doc: Change zsh git completion file name Maxim Belsky via GitGitGadget
2019-10-16  2:06       ` Junio C Hamano

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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=xmqqmue7hlih.fsf@gitster-ct.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=public.belsky@gmail.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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).