doc: Add a note about ~/.zsh/_git file

[mbelsky]

Hey,

Today I've spent a few hours to understand why git-completion doesn't work in my zsh shell. It was because I thought ~/.zsh/_git should be a dictionary with git-completion.zsh file.

I think this change may save some hours for someone else.

cc: Felipe Contreras [email protected]

[gitgitgadget]

Welcome to GitGitGadget

Hi @mbelsky, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that this Pull Request has a good description, as it will be used as cover letter.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

• the lines should not exceed 76 columns,
• the first line should be like a header and typically start with a prefix like "tests:" or "commit:", and
• the commit messages' body should be describing the "why?" of the change.
• Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a PR comment of the form /allow <username>.

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions.

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox ("raw") file corresponding to the mail you want to reply to from the Git mailing list. If you use GMail, you can upload that raw mbox file via:

curl -g --user "<EMailAddress>:<Password>" --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

[dscho]

/allow

[gitgitgadget]

User mbelsky is now allowed to use GitGitGadget.

[dscho]

@mbelsky note that this is related to (but slightly different from) git#609, which has been submitted to the mailing list at https://public-inbox.org/git/0102016d650b16ca-073c796f-065f-4966-9f94-f276c8fe6ee7-000000@eu-west-1.amazonses.com/. You might want to reply-to-all to that mail to mention your support of that patch?

[mbelsky]

@dscho I didn't work with mailing lists, but I'll try. Thank you for this link

[dscho]

@mbelsky You're welcome! Maybe you can increase the chances of Durant's patch by replying to that mail? There are instructions at the bottom of https://public-inbox.org/git/0102016d650b16ca-073c796f-065f-4966-9f94-f276c8fe6ee7-000000@eu-west-1.amazonses.com/, and there is more information about that here, too: https://github.com/gitgitgadget/gitgitgadget/wiki/ReplyToThis

[dscho]

@mbelsky it seems that @durantschoon might be too busy to answer your suggestion at https://public-inbox.org/git/[email protected]/, so maybe you just /submit this here PR?

[dscho]

/azp run

[EDIT] No idea why the build failed for a documentation-only patch. Let's just run it again.

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[azure-pipelines]

Command 'run

[EDIT]' is not supported by Azure Pipelines.



Supported commands

• help:
• Get descriptions, examples and documentation about supported commands
• Example: help "command_name"
• list:
• List all pipelines for this repository using a comment.
• Example: "list"
• run:
• Run all pipelines or a specific pipeline for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify a pipeline to run.
• Example: "run" or "run pipeline_name"
• where:
• Report back the Azure DevOps orgs that are related to this repository and org
• Example: "where"

See additional documentation.

[mbelsky]

@dscho I'm not sure what a solution is better: first, second.

What do you think about that?

[dscho]

I'm not sure what a solution is better: first, second.

What do you think about that?

I have a slight preference for the second, as it gives the caveat right away, right where the readers would get the information about the path.

But what is more important is a responsive contributor ;-)

[mbelsky]

I prefer this second solution too. It comes to my mind later than I created this pr. So today I'll update this pr and submit.

[mbelsky]

/submit

[gitgitgadget]

Submitted as [email protected]

[dscho]

@mbelsky I think that Junio's advice is sound. If you agree, please amend your commit, force-push, and send another iteration of this patch by issuing a /submit.

[mbelsky]

Thanks, it's awesome that I can just /submit again after force-push instead of building and sending patch manually.

I'll do that in a few hours.

[mbelsky]

/submit

[gitgitgadget]

Submitted as [email protected]

[durantschoon]

Apologies for my non-responsiveness. I tried multiple times to submit my change, but never succeeded. I will be quite satisfied with any solution that helps future users.

[gitgitgadget]

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Maxim Belsky via GitGitGadget" <[email protected]> writes:

> Signed-off-by: Maxim Belsky <[email protected]>
> Helped-by: Johannes Schindelin <[email protected]>
> Helped-by: Junio C Hamano <[email protected]>

No need to resend (as I'll fix it up locally while queuing), but
your sign-off comes last, as we keep these things chronological.
With help from others, you wrote the patch and finally signed it off
to be applied.

Thanks for working on this.

[gitgitgadget]

This branch is now known as mb/clarify-zsh-completion-doc.

[gitgitgadget]

This patch series was integrated into pu via git@ad00dd3.

[gitgitgadget]

This patch series was integrated into pu via git@2c6a3bd.

[mbelsky]

I've read SZEDER Gábor note and I'll send updated patch today

[mbelsky]

/submit

[gitgitgadget]

Submitted as [email protected]

[gitgitgadget]

This patch series was integrated into pu via git@fb67bfb.

[gitgitgadget]

This patch series was integrated into pu via git@0d65077.

[gitgitgadget]

This patch series was integrated into pu via git@c1ec35d.

[gitgitgadget]

This patch series was integrated into next via git@c1ec35d.

[gitgitgadget]

This patch series was integrated into master via git@c1ec35d.

[gitgitgadget]

Closed via c1ec35d.

[gitgitgadget]

User Felipe Contreras <[email protected]> has been added to the cc: list.