45344: Document where third-party completion functions should be inst…

…alled.
zsh-users · Jan 29, 2020 · 8dab5bc · 8dab5bc
1 parent a06143b
commit 8dab5bc
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,8 @@
+2020-01-29  Daniel Shahaf  <danielsh@apache.org>
+
+	* 45344: INSTALL: Document where third-party completion functions
+	should be installed.
+
 2020-01-28  Daniel Shahaf  <danielsh@apache.org>
 
 	* 45345: Util/ztst-syntax.vim: internal: ztst.vim: Fix

diff --git a/INSTALL b/INSTALL
@@ -251,6 +251,16 @@ source code in the directory that "configure" is in.  For example,
 Note that this is mutually exclusive with using the source directories
 as make can become confused by build files created in the source directories.
 
+Writing third-party autoloadable functions
+------------------------------------------
+
+Third-party autoloadable functions, including but not limited to completion
+functions, should be installed into the share/zsh/site-functions/ directory
+under the respective installation prefix.  That would typically be written as
+$(DESTDIR)$(PREFIX)/share/zsh/site-functions/ in a makefile.  If the
+third-party tool's $(PREFIX) is not the same as zsh's prefix, then that
+directory should be added to $fpath in zsh's initialization files.
+
 
 ================================
 AUTOMATIC NEW USER CONFIGURATION