about summary refs log tree commit diff
diff options
context:
space:
mode:
authorDaniel Shahaf <danielsh@apache.org>2020-01-26 03:35:22 +0000
committerDaniel Shahaf <danielsh@apache.org>2020-01-29 09:02:34 +0000
commit8dab5bc03726168356f76c708919ed011adbaf95 (patch)
tree48438324f866f7222e1e83fa56e9fb4a627072af
parenta06143bb30921b780a9fb0999aebd068b02b2a6c (diff)
downloadzsh-8dab5bc03726168356f76c708919ed011adbaf95.tar.gz
zsh-8dab5bc03726168356f76c708919ed011adbaf95.tar.xz
zsh-8dab5bc03726168356f76c708919ed011adbaf95.zip
45344: Document where third-party completion functions should be installed.
-rw-r--r--ChangeLog5
-rw-r--r--INSTALL10
2 files changed, 15 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 4b6955b67..f15cfbe56 100644
--- 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
index cf70893a7..f347a4480 100644
--- 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