summaryrefslogtreecommitdiff
path: root/plugins/git-extras/README.md
diff options
context:
space:
mode:
authorAndrew Janke <andrew@apjanke.net>2015-10-02 03:07:01 -0400
committerAndrew Janke <andrew@apjanke.net>2015-10-02 03:18:28 -0400
commit7f2656c1263488c1a54af65397ad1d0c450c8e7d (patch)
tree3f4528d1ec1c30e3f8dbedde18a61023144141b5 /plugins/git-extras/README.md
parenta9c882094dedfdefb311db5967b974980cec49ec (diff)
downloadzsh-7f2656c1263488c1a54af65397ad1d0c450c8e7d.tar.gz
zsh-7f2656c1263488c1a54af65397ad1d0c450c8e7d.tar.bz2
zsh-7f2656c1263488c1a54af65397ad1d0c450c8e7d.zip
git-extras: fix for compatibility with zsh _git
This changes all the __git_* functions it was defining to __gitex_* to avoid collisions with the internal functions used inside _git from zsh.
Diffstat (limited to 'plugins/git-extras/README.md')
-rw-r--r--plugins/git-extras/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/plugins/git-extras/README.md b/plugins/git-extras/README.md
new file mode 100644
index 000000000..8f12e297e
--- /dev/null
+++ b/plugins/git-extras/README.md
@@ -0,0 +1,11 @@
+# git-extras
+
+This plugin provides completion definitions for some of the commands defined by [git-extras](http://github.com/tj/git-extras).
+
+## Setup notes
+
+The completions work by augmenting the `_git` completion provided by `zsh`. This only works with the `zsh`-provided `_git`, not the `_git` provided by `git` itself. If you have both `zsh` and `git` installed, you need to make sure that the `zsh`-provided `_git` takes precedence.
+
+### OS X Homebrew Setup
+
+On OS X with Homebrew, you need to install `git` with `brew install git --without-completions`. Otherwise, `git`'s `_git` will take precedence, and you won't see the completions for `git-extras` commands.