# [PATCH] Fix zsh installation instructions 17 messages from 2020-07-02 to 2020-11-03. Participants: Alexey via GitGitGadget, Junio C Hamano, Stefan Haller, Felipe Contreras, Лёша Огоньков. Thread: https://gitlist.dev/t/53788 ## Alexey via GitGitGadget, 2020-07-02 10:51 Subject: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/pull.814.git.git.1593687080695.gitgitgadget%40gmail.com ``` From: Alexey - Fix wrong script in completion configuration. zsh wants bash completion path here, not path to itself. - Add `compinit` autoload command, since whole thing didn't work if it is not loaded. Signed-off-by: Alexey --- Fix zsh installation instructions * Fix wrong script in completion configuration. zsh wants bash completion path here, not path to itself. * Add compinit autoload command, since whole thing didn't work if it is not loaded. Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-814%2Fogonkov%2Fpatch-1-v1 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-814/ogonkov/patch-1-v1 Pull-Request: https://github.com/git/git/pull/814 contrib/completion/git-completion.zsh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh index ce47e86b60..107869036d 100644 --- a/contrib/completion/git-completion.zsh +++ b/contrib/completion/git-completion.zsh @@ -9,13 +9,14 @@ # # If your script is somewhere else, you can configure it on your ~/.zshrc: # -# zstyle ':completion:*:*:git:*' script ~/.git-completion.zsh +# zstyle ':completion:*:*:git:*' script ~/.git-completion.bash # # The recommended way to install this script is to make a copy of it in # ~/.zsh/ directory as ~/.zsh/git-completion.zsh and then add the following # to your ~/.zshrc file: # # fpath=(~/.zsh $fpath) +# autoload -Uz compinit && compinit complete () { base-commit: a08a83db2bf27f015bec9a435f6d73e223c21c5e -- gitgitgadget ``` ## Junio C Hamano, 2020-07-06 22:42 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/xmqqr1to8dv9.fsf%40gitster.c.googlers.com In-Reply-To: ``` > From: Alexey Thanks. Any zsh users raise their hands? Does this change look sane? > - Fix wrong script in completion configuration. zsh wants bash completion > path here, not path to itself. > - Add `compinit` autoload command, since whole thing didn't work > if it is not loaded. > > Signed-off-by: Alexey > --- > Fix zsh installation instructions > > * Fix wrong script in completion configuration. zsh wants bash > completion path here, not path to itself. > * Add compinit autoload command, since whole thing didn't work if it is > not loaded. > > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-814%2Fogonkov%2Fpatch-1-v1 > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-814/ogonkov/patch-1-v1 > Pull-Request: https://github.com/git/git/pull/814 > > contrib/completion/git-completion.zsh | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh > index ce47e86b60..107869036d 100644 > --- a/contrib/completion/git-completion.zsh > +++ b/contrib/completion/git-completion.zsh > @@ -9,13 +9,14 @@ > # > # If your script is somewhere else, you can configure it on your ~/.zshrc: > # > -# zstyle ':completion:*:*:git:*' script ~/.git-completion.zsh > +# zstyle ':completion:*:*:git:*' script ~/.git-completion.bash > # > # The recommended way to install this script is to make a copy of it in > # ~/.zsh/ directory as ~/.zsh/git-completion.zsh and then add the following > # to your ~/.zshrc file: > # > # fpath=(~/.zsh $fpath) > +# autoload -Uz compinit && compinit > > complete () > { > > base-commit: a08a83db2bf27f015bec9a435f6d73e223c21c5e ``` ## Stefan Haller, 2020-10-14 15:10 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/abc4ab95-ed65-1d6b-e964-73734c08cda9%40haller-berlin.de In-Reply-To: ``` On 07.07.20 0:42, Junio C Hamano wrote: >> From: Alexey > > Thanks. > > Any zsh users raise their hands? Does this change look sane? Sorry for the late reply, I only saw this now. Yes, the change is sane. The wrong file extension (.zsh vs. .bash) was a documentation bug that I had noticed myself, but forgot to submit a patch for. The other hunk (adding compinit) is not so important to me; I suppose it was not in the original version because most zsh users already have this in their .zshrc anyway. But it's not wrong, and doesn't hurt to have here, I guess. Best, Stefan >> - Fix wrong script in completion configuration. zsh wants bash completion >> path here, not path to itself. >> - Add `compinit` autoload command, since whole thing didn't work >> if it is not loaded. >> >> Signed-off-by: Alexey >> --- >> Fix zsh installation instructions >> >> * Fix wrong script in completion configuration. zsh wants bash >> completion path here, not path to itself. >> * Add compinit autoload command, since whole thing didn't work if it is >> not loaded. >> >> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-814%2Fogonkov%2Fpatch-1-v1 >> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-814/ogonkov/patch-1-v1 >> Pull-Request: https://github.com/git/git/pull/814 >> >> contrib/completion/git-completion.zsh | 3 ++- >> 1 file changed, 2 insertions(+), 1 deletion(-) >> >> diff --git a/contrib/completion/git-completion.zsh b/contrib/completion/git-completion.zsh >> index ce47e86b60..107869036d 100644 >> --- a/contrib/completion/git-completion.zsh >> +++ b/contrib/completion/git-completion.zsh >> @@ -9,13 +9,14 @@ >> # >> # If your script is somewhere else, you can configure it on your ~/.zshrc: >> # >> -# zstyle ':completion:*:*:git:*' script ~/.git-completion.zsh >> +# zstyle ':completion:*:*:git:*' script ~/.git-completion.bash >> # >> # The recommended way to install this script is to make a copy of it in >> # ~/.zsh/ directory as ~/.zsh/git-completion.zsh and then add the following >> # to your ~/.zshrc file: >> # >> # fpath=(~/.zsh $fpath) >> +# autoload -Uz compinit && compinit >> >> complete () >> { >> >> base-commit: a08a83db2bf27f015bec9a435f6d73e223c21c5e > ``` ## Junio C Hamano, 2020-10-16 17:06 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/xmqqpn5icd8b.fsf%40gitster.c.googlers.com In-Reply-To: ``` Stefan Haller writes: > On 07.07.20 0:42, Junio C Hamano wrote: >>> From: Alexey >> Thanks. >> Any zsh users raise their hands? Does this change look sane? > > Sorry for the late reply, I only saw this now. > > Yes, the change is sane. The wrong file extension (.zsh vs. .bash) was > a documentation bug that I had noticed myself, but forgot to submit a > patch for. > > The other hunk (adding compinit) is not so important to me; I suppose > it was not in the original version because most zsh users already have > this in their .zshrc anyway. But it's not wrong, and doesn't hurt to > have here, I guess. Thanks. Will queue. ``` ## Felipe Contreras, 2020-10-25 03:29 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/CAMP44s3%3DCUmx_7DCExK7L4trZvQTxO67Qk20eexsP3su-3RyKQ%40mail.gmail.com In-Reply-To: ``` On Wed, Oct 14, 2020 at 12:39 PM Stefan Haller wrote: > Yes, the change is sane. The wrong file extension (.zsh vs. .bash) was a > documentation bug that I had noticed myself, but forgot to submit a > patch for. Yes, a patch was wrongly applied that changed it from .sh to .zsh. > The other hunk (adding compinit) is not so important to me; I suppose it > was not in the original version because most zsh users already have this > in their .zshrc anyway. But it's not wrong, and doesn't hurt to have > here, I guess. If you don't have compinit, then how is the '_git' script being loaded in the first place? -- Felipe Contreras ``` ## Stefan Haller, 2020-10-27 08:29 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: <0a5488b5-e39f-7b31-2a3a-db63c1fc99ab@haller-berlin.de> URL: https://gitlist.dev/e/0a5488b5-e39f-7b31-2a3a-db63c1fc99ab%40haller-berlin.de In-Reply-To: ``` On 25.10.20 4:29, Felipe Contreras wrote: > On Wed, Oct 14, 2020 at 12:39 PM Stefan Haller wrote: > >> Yes, the change is sane. The wrong file extension (.zsh vs. .bash) was a >> documentation bug that I had noticed myself, but forgot to submit a >> patch for. > > Yes, a patch was wrongly applied that changed it from .sh to .zsh. > >> The other hunk (adding compinit) is not so important to me; I suppose it >> was not in the original version because most zsh users already have this >> in their .zshrc anyway. But it's not wrong, and doesn't hurt to have >> here, I guess. > > If you don't have compinit, then how is the '_git' script being loaded > in the first place? > ``` ## Stefan Haller, 2020-10-27 08:32 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/abc34ced-0c0f-4024-a50c-30e4ca31b325%40haller-berlin.de In-Reply-To: ``` On 25.10.20 4:29, Felipe Contreras wrote: >> The other hunk (adding compinit) is not so important to me; I suppose it >> was not in the original version because most zsh users already have this >> in their .zshrc anyway. But it's not wrong, and doesn't hurt to have >> here, I guess. > > If you don't have compinit, then how is the '_git' script being loaded > in the first place? I didn't say it's unnecessary to have it in your .zshrc. I just said it's maybe unnecessary to document it here because most zsh users have it in their .zshrc already anyway. (Sorry for the other empty mail, I hit the wrong button...) Best, Stefan ``` ## Лёша Огоньков, 2020-10-27 08:59 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/CAKU%2BSVKad4q-2tTrYXa%2BDJBz5UJOtndEe3-4Uvnd5GZ92543ng%40mail.gmail.com In-Reply-To: ``` As an inexperienced zsh user it took me ages to understand why the whole thing is not working. Regards Alexey On Tue, 27 Oct 2020 at 11:32, Stefan Haller wrote: > > On 25.10.20 4:29, Felipe Contreras wrote: > >> The other hunk (adding compinit) is not so important to me; I suppose it > >> was not in the original version because most zsh users already have this > >> in their .zshrc anyway. But it's not wrong, and doesn't hurt to have > >> here, I guess. > > > > If you don't have compinit, then how is the '_git' script being loaded > > in the first place? > > I didn't say it's unnecessary to have it in your .zshrc. I just said > it's maybe unnecessary to document it here because most zsh users have > it in their .zshrc already anyway. > > (Sorry for the other empty mail, I hit the wrong button...) > > Best, > Stefan ``` ## Junio C Hamano, 2020-10-27 20:00 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/xmqqwnzbbfsi.fsf%40gitster.c.googlers.com In-Reply-To: ``` Лёша Огоньков writes: > On Tue, 27 Oct 2020 at 11:32, Stefan Haller wrote: >> >> On 25.10.20 4:29, Felipe Contreras wrote: >> >> The other hunk (adding compinit) is not so important to me; I suppose it >> >> was not in the original version because most zsh users already have this >> >> in their .zshrc anyway. But it's not wrong, and doesn't hurt to have >> >> here, I guess. >> > >> > If you don't have compinit, then how is the '_git' script being loaded >> > in the first place? >> >> I didn't say it's unnecessary to have it in your .zshrc. I just said >> it's maybe unnecessary to document it here because most zsh users have >> it in their .zshrc already anyway. > > As an inexperienced zsh user it took me ages to understand why the > whole thing is not working. So,... even though it may look to more experienced zsh users that it is unnecessary to document it in this file, in your opinion, it is a good idea to mention "compinit" to help less experienced users? In any case, the patch in question is the only thing in flight that conflicts with Felipe's 29 patch series, and the change to zstyle line is common between both efforts, so it is just between adding the "autoload -Uz compinit && compinit" near the fpath=(...) thing or leaving it out. I'll let those who know zsh to figure it out. I suspect that the resolution would be either to ask Felipe to rebase his on yours, rebase yours on top of Felipe's, or just drop yours (if "autoload" thing is unnecessary as Stefan suspects---I cannot tell what Felipe wants to suggest by his response, between "unless you have compinit you wouldn't be using this script so why write it?" and "your users need to be taught about the need _somehow_, so why not make this the place to do so?"). Thanks. ``` ## Felipe Contreras, 2020-10-28 01:31 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/CAMP44s32wNhZsAgrLoz9-HFDV%3DaPjCp6bcJB1JsBeE%2Bp8Qc7vA%40mail.gmail.com In-Reply-To: ``` On Tue, Oct 27, 2020 at 2:59 AM Лёша Огоньков wrote: > > As an inexperienced zsh user it took me ages to understand why the > whole thing is not working. What was the reason? The filename wasn't correct? -- Felipe Contreras ``` ## Felipe Contreras, 2020-10-28 01:45 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/CAMP44s2DR%3DpV3frOePMbSyikA-KonZ5XWD7o5SqKhUbzohAFtQ%40mail.gmail.com In-Reply-To: ``` On Tue, Oct 27, 2020 at 2:00 PM Junio C Hamano wrote: > > Лёша Огоньков writes: > So,... even though it may look to more experienced zsh users that it > is unnecessary to document it in this file, in your opinion, it is a > good idea to mention "compinit" to help less experienced users? The first time you run zsh you are greeted with a configuration dialog that includes this question: --- The new completion system (compsys) allows you to complete commands, arguments and special shell syntax such as variables. It provides completions for a wide range of commonly used commands in most cases simply by typing the TAB key. Documentation is in the zshcompsys manual page. If it is not turned on, only a few simple completions such as filenames are available but the time to start the shell is slightly shorter. You can: (1) Turn on completion with the default options. (2) Run the configuration tool (compinstall). You can also run this from the command line with the following commands: autoload -Uz compinstall compinstall if you don't want to configure completion now. (0) Don't turn on completion. --- If you don't turn on completion, the completion doesn't work for *any* command. I think most users would understand why git completion doesn't work if completion doesn't work for any command. > In any case, the patch in question is the only thing in flight that > conflicts with Felipe's 29 patch series, and the change to zstyle > line is common between both efforts, so it is just between adding > the "autoload -Uz compinit && compinit" near the fpath=(...) thing > or leaving it out. I would rather leave it out. If we add this configuration, I would do it in a separate patch that includes text explaining what that line is, and why it might be needed. -- Felipe Contreras ``` ## Junio C Hamano, 2020-10-29 17:50 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/xmqqtuuc7wgu.fsf%40gitster.c.googlers.com In-Reply-To: ``` Felipe Contreras writes: > On Tue, Oct 27, 2020 at 2:00 PM Junio C Hamano wrote: >> >> Лёша Огоньков writes: > >> So,... even though it may look to more experienced zsh users that it >> is unnecessary to document it in this file, in your opinion, it is a >> good idea to mention "compinit" to help less experienced users? > > The first time you run zsh you are greeted with a configuration dialog > that includes this question: Ahh, yes, that reminds me why I gave up trying it out the last time. The large dialog asking my permission to contaminate ~/.* was simply too scary and distasteful for a "dip my toe in the water" sightseer. > If you don't turn on completion, the completion doesn't work for *any* command. > > I think most users would understand why git completion doesn't work if > completion doesn't work for any command. OK, that sort of makes sense. > I would rather leave it out. Makes sense. Instead of adjusting my rerere database for that, ejecting lo/zsh-completion topic would be easier---what the other half of that patch does is already in your 29-patch series. Thanks. ``` ## Junio C Hamano, 2020-10-29 19:09 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/xmqqpn507ss8.fsf%40gitster.c.googlers.com In-Reply-To: ``` Junio C Hamano writes: >> I would rather leave it out. > > Makes sense. Instead of adjusting my rerere database for that, > ejecting lo/zsh-completion topic would be easier---what the other > half of that patch does is already in your 29-patch series. Actually, I already have an entry in my rerere database to resolve the merge of these topics to drop the "autoload" suggestion, so I won't have to do anything other than just queuing the v3 of your 29-patch series. ``` ## Felipe Contreras, 2020-11-02 20:49 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/CAMP44s1%2BbJMrmJWeAQx18S-%3DspoKb0BmzWyJ4WgzuE%2BrNuf0cg%40mail.gmail.com In-Reply-To: ``` On Thu, Oct 29, 2020 at 11:50 AM Junio C Hamano wrote: > Felipe Contreras writes: > > The first time you run zsh you are greeted with a configuration dialog > > that includes this question: > > Ahh, yes, that reminds me why I gave up trying it out the last time. > The large dialog asking my permission to contaminate ~/.* was simply > too scary and distasteful for a "dip my toe in the water" sightseer. You don't *need* to run the dialog, just touch a ~/.zshrc file. This should be enough: --- autoload -U compinit && compinit --- > Makes sense. Instead of adjusting my rerere database for that, > ejecting lo/zsh-completion topic would be easier---what the other > half of that patch does is already in your 29-patch series. Yes. -- Felipe Contreras ``` ## Felipe Contreras, 2020-11-02 20:54 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/CAMP44s2V42MAi5R9XG94MxD9Ap1p6Y9FBAJOL60PSQSZspb3TA%40mail.gmail.com In-Reply-To: ``` On Mon, Nov 2, 2020 at 2:49 PM Felipe Contreras wrote: > You don't *need* to run the dialog, just touch a ~/.zshrc file. > > This should be enough: > --- > autoload -U compinit && compinit > --- Or put that in /tmp/zsh, and run zsh with: ZDOTDIR=/tmp/zsh zsh -l No contamination needed. -- Felipe Contreras ``` ## Junio C Hamano, 2020-11-02 22:37 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/xmqq7dr3s7vm.fsf%40gitster.c.googlers.com In-Reply-To: ``` Felipe Contreras writes: > This should be enough: > --- > autoload -U compinit && compinit > --- > >> Makes sense. Instead of adjusting my rerere database for that, >> ejecting lo/zsh-completion topic would be easier---what the other >> half of that patch does is already in your 29-patch series. Your 29-patch series is now in 'next'; I have this feeing that nobody around here would offer any meaningful reviews on it, so it may graduate sooner than the usual topics. Thanks. ``` ## Junio C Hamano, 2020-11-03 01:02 Subject: Re: [PATCH] Fix zsh installation instructions Message-ID: URL: https://gitlist.dev/e/xmqq361rqmlv.fsf%40gitster.c.googlers.com In-Reply-To: ``` Felipe Contreras writes: > Or put that in /tmp/zsh, and run zsh with: > > ZDOTDIR=/tmp/zsh zsh -l > > No contamination needed. Thanks for a few messages with tips, but the point is that it is already much more than what a "dip my toe in the water" sightseer wants to figure out these workarounds. ```