Skip to content

Commit 35d5ae6

Browse files
sbeyergitster
authored andcommitted
api-run-command.txt: talk about run_hook()
Signed-off-by: Stephan Beyer <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent ae98a00 commit 35d5ae6

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Documentation/technical/api-run-command.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,21 @@ Functions
5252
Wait for the completion of an asynchronous function that was
5353
started with start_async().
5454

55+
`run_hook`::
56+
57+
Run a hook.
58+
The first argument is a pathname to an index file, or NULL
59+
if the hook uses the default index file or no index is needed.
60+
The second argument is the name of the hook.
61+
The further arguments (up to 9) correspond to the hook arguments.
62+
The last argument has to be NULL to terminate the arguments list.
63+
If the hook does not exist or is not executable, the return
64+
value will be zero.
65+
If it is executable, the hook will be executed and the exit
66+
status of the hook is returned.
67+
On execution, .stdout_to_stderr and .no_stdin will be set.
68+
(See below.)
69+
5570

5671
Data structures
5772
---------------

0 commit comments

Comments
 (0)