changeset 32506:7a7c3369ee26

zsh_completion: install as _hg not hg The contrib/zsh_completion file itself says to name it _hg. With a name like `hg`, if the user has a line like `autoload ${^fpath}/*(N-.:t)` in their zshrc, it will create a shell function named `hg` that will hide the actual hg command and make hg unusable. Separately from that though, the underscore prefix makes it actually work. The zsh man page states: The convention for autoloaded functions used in completion is that they start with an underscore This does not seem to just be a "convention", though. With the ill-advised line removed from my zshrc and the file named `/usr/local/share/zsh/site-functions/hg` (without the underscore), these completions did not seem to get loaded and the ones from the zsh installation were loaded instead. If I renamed them to be `/usr/local/share/zsh/site-functions/_hg`, however, they were loaded. I manually tested the above statement by starting a new zsh instance with the file in `/usr/local/share/zsh/site-functions` with the following names: - As `hg`, `which _hg_labels` did not show anything - As `_hg`, `which _hg_labels` showed the expected function.
author Kyle Lippincott <spectral@google.com>
date Fri, 26 May 2017 13:24:07 -0700
parents a38ed42cd23c
children c2b7fb580794
files Makefile tests/test-mac-packages.t
diffstat 2 files changed, 3 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/Makefile	Mon Mar 20 17:50:31 2017 -0400
+++ b/Makefile	Fri May 26 13:24:07 2017 -0700
@@ -169,7 +169,7 @@
         # install zsh completions - this location appears to be
         # searched by default as of macOS Sierra.
 	install -d build/mercurial/usr/local/share/zsh/site-functions/
-	install -m 0644 contrib/zsh_completion build/mercurial/usr/local/share/zsh/site-functions/hg
+	install -m 0644 contrib/zsh_completion build/mercurial/usr/local/share/zsh/site-functions/_hg
         # install bash completions - there doesn't appear to be a
         # place that's searched by default for bash, so we'll follow
         # the lead of Apple's git install and just put it in a
--- a/tests/test-mac-packages.t	Mon Mar 20 17:50:31 2017 -0400
+++ b/tests/test-mac-packages.t	Fri May 26 13:24:07 2017 -0700
@@ -29,8 +29,8 @@
   ./Library/Python/2.7/site-packages/mercurial/pure/bdiff.py	100644	0/0
   ./Library/Python/2.7/site-packages/mercurial/pure/bdiff.pyc	100644	0/0
   ./Library/Python/2.7/site-packages/mercurial/pure/bdiff.pyo	100644	0/0
-  $ grep zsh/site-functions/hg boms.txt | cut -d '	' -f 1,2,3
-  ./usr/local/share/zsh/site-functions/hg	100644	0/0
+  $ grep zsh/site-functions/_hg boms.txt | cut -d '	' -f 1,2,3
+  ./usr/local/share/zsh/site-functions/_hg	100644	0/0
   $ grep hg-completion.bash boms.txt | cut -d '	' -f 1,2,3
   ./usr/local/hg/contrib/hg-completion.bash	100644	0/0
   $ egrep 'man[15]' boms.txt | cut -d '	' -f 1,2,3