Browse Source

api-run-command.txt: talk about run_hook()

Signed-off-by: Stephan Beyer <s-beyer@gmx.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Stephan Beyer 16 years ago committed by Junio C Hamano
parent
commit
35d5ae679c
  1. 15
      Documentation/technical/api-run-command.txt

15
Documentation/technical/api-run-command.txt

@ -52,6 +52,21 @@ Functions @@ -52,6 +52,21 @@ 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 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
---------------

Loading…
Cancel
Save