* [PATCH] completion (zsh): fix misleading install location
@ 2019-06-06 21:38 Durant Schoon
2019-06-06 22:44 ` Denton Liu
` (3 more replies)
0 siblings, 4 replies; 5+ messages in thread
From: Durant Schoon @ 2019-06-06 21:38 UTC (permalink / raw)
To: git
When the code comment in the zsh completion suggests that this file
should be copied to `~/.zsh`, many users might be misled to believe that
this refers to a file location. But it refers to a directory, and won't
work when it is a file.
Let's just add a slash, to make it abundantly clear that this must be a
directory.
(thank you to Johannes Schindelin for the suggested wording and title)
Signed-off-by: B. Durant Schoon durant.schoon@gmail.com
---
contrib/completion/git-completion.zsh | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh
index 886bf95d1f594..0e63004e2613e 100644
--- a/contrib/completion/git-completion.zsh
+++ b/contrib/completion/git-completion.zsh
@@ -11,8 +11,8 @@
#
# 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/',
+# and then add the following to your ~/.zshrc file:
#
# fpath=(~/.zsh $fpath)
--
https://github.com/git/git/pull/609
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] completion (zsh): fix misleading install location
2019-06-06 21:38 [PATCH] completion (zsh): fix misleading install location Durant Schoon
@ 2019-06-06 22:44 ` Denton Liu
2019-06-06 22:52 ` Felipe Contreras
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Denton Liu @ 2019-06-06 22:44 UTC (permalink / raw)
To: Durant Schoon; +Cc: git
Hi Durant,
Just a couple of small things:
On Thu, Jun 06, 2019 at 09:38:54PM +0000, Durant Schoon wrote:
> When the code comment in the zsh completion suggests that this file
> should be copied to `~/.zsh`, many users might be misled to believe that
> this refers to a file location. But it refers to a directory, and won't
> work when it is a file.
>
> Let's just add a slash, to make it abundantly clear that this must be a
> directory.
>
> (thank you to Johannes Schindelin for the suggested wording and title)
Maybe this would be better incorporated as a Helped-by: or Suggested-by:
tag at the bottom?
>
> Signed-off-by: B. Durant Schoon durant.schoon@gmail.com
The email in your sign-off line should be wrapped in <>, i.e. it should
be
B. Durant Schoon <durant.schoon@gmail.com>
Other than that, the patch looks fine to me.
Thanks,
Denton
> ---
> contrib/completion/git-completion.zsh | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh
> index 886bf95d1f594..0e63004e2613e 100644
> --- a/contrib/completion/git-completion.zsh
> +++ b/contrib/completion/git-completion.zsh
> @@ -11,8 +11,8 @@
> #
> # 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/',
> +# and then add the following to your ~/.zshrc file:
> #
> # fpath=(~/.zsh $fpath)
>
>
> --
> https://github.com/git/git/pull/609
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] completion (zsh): fix misleading install location
2019-06-06 21:38 [PATCH] completion (zsh): fix misleading install location Durant Schoon
2019-06-06 22:44 ` Denton Liu
@ 2019-06-06 22:52 ` Felipe Contreras
2019-09-24 20:51 ` Durant Schoon
2019-10-01 21:05 ` Maxim Belsky
3 siblings, 0 replies; 5+ messages in thread
From: Felipe Contreras @ 2019-06-06 22:52 UTC (permalink / raw)
To: Durant Schoon; +Cc: Git
On Thu, Jun 6, 2019 at 5:37 PM Durant Schoon <durant.schoon@gmail.com> wrote:
> diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh
> index 886bf95d1f594..0e63004e2613e 100644
> --- a/contrib/completion/git-completion.zsh
> +++ b/contrib/completion/git-completion.zsh
> @@ -11,8 +11,8 @@
> #
> # 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/',
> +# and then add the following to your ~/.zshrc file:
~/.zsh/_git should be a file, not a directory.
--
Felipe Contreras
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH] completion (zsh): fix misleading install location
2019-06-06 21:38 [PATCH] completion (zsh): fix misleading install location Durant Schoon
2019-06-06 22:44 ` Denton Liu
2019-06-06 22:52 ` Felipe Contreras
@ 2019-09-24 20:51 ` Durant Schoon
2019-10-01 21:05 ` Maxim Belsky
3 siblings, 0 replies; 5+ messages in thread
From: Durant Schoon @ 2019-09-24 20:51 UTC (permalink / raw)
To: git
When the code comment in the zsh completion suggests that this file
should be copied to `~/.zsh`, many users might be misled to believe that
this refers to a file location. But it refers to a directory, and won't
work when it is a file.
Let's just add a slash, to make it abundantly clear that this must be a
directory.
Signed-off-by: B. Durant Schoon <durant.schoon@gmail.com>
Helped-by: Johannes Schindelin
---
contrib/completion/git-completion.zsh | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh
index 886bf95d1f594..0e63004e2613e 100644
--- a/contrib/completion/git-completion.zsh
+++ b/contrib/completion/git-completion.zsh
@@ -11,8 +11,8 @@
#
# 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/',
+# and then add the following to your ~/.zshrc file:
#
# fpath=(~/.zsh $fpath)
--
https://github.com/git/git/pull/609
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] completion (zsh): fix misleading install location
2019-06-06 21:38 [PATCH] completion (zsh): fix misleading install location Durant Schoon
` (2 preceding siblings ...)
2019-09-24 20:51 ` Durant Schoon
@ 2019-10-01 21:05 ` Maxim Belsky
3 siblings, 0 replies; 5+ messages in thread
From: Maxim Belsky @ 2019-10-01 21:05 UTC (permalink / raw)
To: Durant Schoon; +Cc: git
Hey,
I face same issue a few days ago. Initially I thought `~/.zsh/_git` should be a dictionary. I’ve made all required actions, but completion didn't work. After a few hours I found that it should be just a file instead of a dictionary.
I have two ideas how to patch this comments to help another users setup completion:
1. Add a note that `~/.zsh/_git` should be a file https://github.com/mbelsky/git/commit/e951a0dee5f124ad755d32fa5cc5cded471d389b
2. Change the patch to make it more obvious https://github.com/mbelsky/git/commit/6c839727163b29b2d2cf5d2ec7f780c2826848d6
It’s my first time mail listing experience so I just put links on github to don’t make something wrong.
What do you think about this changes?
> On 7 Jun 2019, at 00:38, Durant Schoon <durant.schoon@gmail.com> wrote:
>
> diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh
> index 886bf95d1f594..0e63004e2613e 100644
> --- a/contrib/completion/git-completion.zsh
> +++ b/contrib/completion/git-completion.zsh
> @@ -11,8 +11,8 @@
> #
> # 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/',
> +# and then add the following to your ~/.zshrc file:
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2019-10-01 21:05 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-06-06 21:38 [PATCH] completion (zsh): fix misleading install location Durant Schoon
2019-06-06 22:44 ` Denton Liu
2019-06-06 22:52 ` Felipe Contreras
2019-09-24 20:51 ` Durant Schoon
2019-10-01 21:05 ` Maxim Belsky
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).