diff options
| author |  Stephan Beyer <s-beyer@gmx.net> | 2009-01-16 20:10:00 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2009-01-17 17:16:34 -0800 |
| commit | 35d5ae679c2a6bc2a5f70f9209844ae8c14ae9e3 (patch) | |
| tree | 50dc307369e6e09e0d85fcdf708d2f314648e5bf | |
| parent | Move run_hook() from builtin-commit.c into run-command.c (libgit) (diff) | |
| download | tgif-35d5ae679c2a6bc2a5f70f9209844ae8c14ae9e3.tar.xz | |
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>
| -rw-r--r-- | Documentation/technical/api-run-command.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/technical/api-run-command.txt b/Documentation/technical/api-run-command.txt index 82e9e831b6..13e7b6361b 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_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 --------------- |