Re: [PATCH] Fix zsh installation instructions

From: Felipe Contreras <felipe.contreras@gmail.com>
Date: Oct 28, 2020, 01:45 UTC
Message-ID: <CAMP44s2DR=pV3frOePMbSyikA-KonZ5XWD7o5SqKhUbzohAFtQ@mail.gmail.com>
In-Reply-To: <xmqqwnzbbfsi.fsf@gitster.c.googlers.com>

On Tue, Oct 27, 2020 at 2:00 PM Junio C Hamano <gitster@pobox.com> wrote:

>
> Лёша Огоньков  <lesha.ogonkov@gmail.com> 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.

Show 5 quoted lines

> 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