summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2009-01-21 16:50:43 -0800
committerLibravatar Junio C Hamano <gitster@pobox.com>2009-01-21 16:50:43 -0800
commit1afcde6da1221bdb85a3630d995f9ca384042cb9 (patch)
tree9a010c9a301e5574aacd6d56a48e9c18d9496bb0 /Documentation
parentMerge branch 'jk/color-parse' (diff)
parentrun_hook(): allow more than 9 hook arguments (diff)
downloadtgif-1afcde6da1221bdb85a3630d995f9ca384042cb9.tar.xz
Merge branch 'sb/hook-cleanup'
* sb/hook-cleanup: run_hook(): allow more than 9 hook arguments run_hook(): check the executability of the hook before filling argv api-run-command.txt: talk about run_hook() Move run_hook() from builtin-commit.c into run-command.c (libgit) checkout: don't crash on file checkout before running post-checkout hook
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/technical/api-run-command.txt15
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..2efe7a40be 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 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
---------------