path: root/Documentation/technical/api-run-command.txt
diff options
authorStephan Beyer <>2009-01-16 19:10:00 (GMT)
committerJunio C Hamano <>2009-01-18 01:16:34 (GMT)
commit35d5ae679c2a6bc2a5f70f9209844ae8c14ae9e3 (patch)
tree50dc307369e6e09e0d85fcdf708d2f314648e5bf /Documentation/technical/api-run-command.txt
parentae98a0089ff7f7641ed15ddd595797de56eb49f1 (diff)
api-run-command.txt: talk about run_hook()
Signed-off-by: Stephan Beyer <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/technical/api-run-command.txt')
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/technical/api-run-command.txt b/Documentation/technical/api-run-command.txt
index 82e9e83..13e7b63 100644
--- a/Documentation/technical/api-run-command.txt
+++ b/Documentation/technical/api-run-command.txt
@@ -52,6 +52,21 @@ Functions
Wait for the completion of an asynchronous function that was
started with start_async().
+ Run a hook.
+ The first argument is a pathname to an index file, or NULL
+ if the hook uses the default index file or no index is needed.
+ The second argument is the name of the hook.
+ The further arguments (up to 9) correspond to the hook arguments.
+ The last argument has to be NULL to terminate the arguments list.
+ If the hook does not exist or is not executable, the return
+ value will be 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