[PATCH 2/2] api-run-command.txt: talk about run_hook()
Signed-off-by: Stephan Beyer <s-beyer@gmx.net>
---
I noticed that the last patch is lacking some documentation.
Here it is. Should perhaps be squashed.
Documentation/technical/api-run-command.txt | 16 ++++++++++++++++
1 files changed, 16 insertions(+), 0 deletions(-)
diff --git a/Documentation/technical/api-run-command.txt b/Documentation/technical/api-run-command.txt
index 82e9e83..1241f48 100644
--- a/Documentation/technical/api-run-command.txt
+++ b/Documentation/technical/api-run-command.txt
@@ -52,6 +52,22 @@ Functions
Wait for the completion of an asynchronous function that was
started with start_async().
+`run_hook`::
+
+ Run a hook.
+ The first argument is a string to an index file or NULL
+ if the default index file or no index is used at all.
+ The second argument is the name of the hook.
+ The further variable number (up to 9) of arguments correspond
+ to the hook arguments.
+ The last argument has to be NULL to terminate the variable
+ arguments list.
+ If the hook is not executable, the return value is zero.
+ If it is executable, the hook will be executed and the exit
+ status of the hook is returned.
+ On execution, .stdout_to_stderr and .no_stdin will be set.
+ (See below.)
+
Data structures
---------------
--
1.6.1.160.gecdb
Stephan Beyer <s-beyer@gmx.net>