Re: [PATCH 1/1] doc: Change zsh git completion file name

From: Johannes Schindelin <johannes.schindelin@gmx.de>
Date: Oct 10, 2019, 21:12 UTC
Message-ID: <nycvar.QRO.7.76.6.1910102310260.46@tvgsbejvaqbjf.bet>
In-Reply-To: <ae00e1e3932b3364da68fa66e2ec5fbcce124bdc.1570726611.git.gitgitgadget@gmail.com>

Hi Maxim,

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

Thanks, Johannes

Show 23 quoted lines

> ---
>  contrib/completion/git-completion.zsh | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh
> index 886bf95d1f..c0eca3ff25 100644
> --- a/contrib/completion/git-completion.zsh
> +++ b/contrib/completion/git-completion.zsh
> @@ -11,8 +11,9 @@
>  #
>  #  zstyle ':completion:*:*:git:*' script ~/.git-completion.zsh
>  #
> -# 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:
>  #
>  #  fpath=(~/.zsh $fpath)
>
> --
> gitgitgadget
>