diff options
| author | Justin Tobler <jltobler@gmail.com> | 2024-07-15 13:37:39 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-07-15 11:43:38 -0700 |
| commit | 8db8786fc2de36731738fd480d1df422c6e86579 (patch) | |
| tree | e1e29d75de33c03842987f9d655832eacedc7bf3 | |
| parent | 337b4d400023d22207bcc3c29e9ebab31bf96fc2 (diff) | |
| download | git-8db8786fc2de36731738fd480d1df422c6e86579.tar.xz | |
doc: clarify post-receive hook behavior
The `githooks` documentation mentions that the post-receive hook
executes once after git-receive-pack(1) updates all references and that
it also receives the same information as the pre-receive hook on
standard input. This is misleading though because the hook only
executes once if at least one of the attempted reference updates is
successful. Also, while each line provided on standard input is in the
same format as the pre-receive hook, the information received only
includes the set of references that were successfully updated.
Update the documentation to clarify these points and also provide a
reference to the post-receive hook section of the `git-receive-pack`
documentation which has additional information.
Signed-off-by: Justin Tobler <jltobler@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/githooks.txt | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 883982e7a0..efd7b7407b 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -415,13 +415,13 @@ post-receive This hook is invoked by linkgit:git-receive-pack[1] when it reacts to `git push` and updates reference(s) in its repository. -It executes on the remote repository once after all the refs have -been updated. +The hook executes on the remote repository once after all the proposed +ref updates are processed and if at least one ref is updated as the +result. -This hook executes once for the receive operation. It takes no -arguments, but gets the same information as the -<<pre-receive,'pre-receive'>> -hook does on its standard input. +The hook takes no arguments. It receives one line on standard input for +each ref that is successfully updated following the same format as the +<<pre-receive,'pre-receive'>> hook. This hook does not affect the outcome of `git receive-pack`, as it is called after the real work is done. @@ -448,6 +448,9 @@ environment variables will not be set. If the client selects to use push options, but doesn't transmit any, the count variable will be set to zero, `GIT_PUSH_OPTION_COUNT=0`. +See the "post-receive" section in linkgit:git-receive-pack[1] for +additional details. + [[post-update]] post-update ~~~~~~~~~~~ |