Improve Zsh completion installation docs #1962
Conversation
Fixes 1956
|
+1. I like this change. It'd clear up some confusion for me – it wasn't clear to me that you need to delete the Git-provided How about adding a link from the main README.m to this etc/README.md doc, too? Would make it easier to find. |
|
@apjanke Good idea. I'm happy to make that change. Is there anything else I need to change to get this approved/merged? |
| # This is also necessary for hub's Zsh completions to work: | ||
| # https://github.com/github/hub/issues/1956. | ||
| function () { | ||
| GIT_ZSH_COMPLETIONS_FILE_PATH="$(brew --prefix)/share/zsh/site-functions/_git" |
There was a problem hiding this comment.
Why is this inside an anonymous function? If the goal was to not leak the GIT_ZSH_COMPLETIONS_FILE_PATH variable, shouldn't it be defined as local then?
| # This is also necessary for hub's Zsh completions to work: | ||
| # https://github.com/github/hub/issues/1956. | ||
| function () { | ||
| GIT_ZSH_COMPLETIONS_FILE_PATH="$(brew --prefix)/share/zsh/site-functions/_git" |
There was a problem hiding this comment.
Ideally, this function should gracefully degrade (not show any error output) if brew --prefix resulted in an error.
|
|
||
| If you installed Zsh and Git via Homebrew, you will need to delete Git's official Zsh completions to allow Zsh's official Git completions to work, which in turn will allow hub's Zsh completions to work. | ||
|
|
||
| You can do this deletion in `.zshrc`, which ensures the file remains deleted even after upgrades of Git. |
There was a problem hiding this comment.
s/You can/You should
We should stress out that this should be inside a script, since doing it as a one-time operation is futile as it will be overriden the next time a person does an upgrade across the board with Homebrew
|
|
||
| If you're using Homebrew, just run `brew install hub` and you should be all set with auto-completion. | ||
| If you're using Homebrew, just run `brew install hub` and you should be all set with auto-completion (for both Bash and Zsh). |
There was a problem hiding this comment.
This is not true (for zsh). The reader might think that they are done at this point. However, if they also installed git with Homebrew, then their hub (when aliased as "git") completions are busted.
This sentence should add that you're all set for bash, but that you should read on for zsh instructions.
Fixes #1956