about summary refs log tree commit diff
diff options
context:
space:
mode:
authorDaniel Shahaf <d.s@daniel.shahaf.name>2016-01-15 06:30:12 +0000
committerDaniel Shahaf <d.s@daniel.shahaf.name>2016-01-15 06:30:12 +0000
commit69379369daf5a159f7ac34a33778668d8d516848 (patch)
treeea23008a6cfa70ce1d43dfac14aa84b40e6ad9ba
parenta45a9fa1042cc48e4d99311c5aa25f029f8a13c2 (diff)
downloadzsh-69379369daf5a159f7ac34a33778668d8d516848.tar.gz
zsh-69379369daf5a159f7ac34a33778668d8d516848.tar.xz
zsh-69379369daf5a159f7ac34a33778668d8d516848.zip
unposted: Extend docstring of callhookfunc().
-rw-r--r--ChangeLog2
-rw-r--r--Src/utils.c3
2 files changed, 5 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index abc67383e..fbfc6c127 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2016-01-15  Daniel Shahaf  <d.s@daniel.shahaf.name>
 
+	* unposted: Src/utils.c: Extend docstring of callhookfunc().
+
 	* unposted: Functions/VCS_Info/Backends/VCS_INFO_detect_p4:
 	Fix typo in comment.
 
diff --git a/Src/utils.c b/Src/utils.c
index 6d0f88d6d..788eba97e 100644
--- a/Src/utils.c
+++ b/Src/utils.c
@@ -1450,6 +1450,9 @@ time_t lastwatch;
  * If "retval" is not NULL, the return value of the first hook function to
  * return non-zero is stored in *"retval".  The return value is not otherwise
  * available as the calling context is restored.
+ *
+ * Returns 0 if at least one function was called (regardless of that function's
+ * exit status), and 1 otherwise.
  */
 
 /**/