Skip to content

Commit 8db8786

Browse files
jltoblergitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 337b4d4 commit 8db8786

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

Documentation/githooks.txt

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -415,13 +415,13 @@ post-receive
415415

416416
This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
417417
`git push` and updates reference(s) in its repository.
418-
It executes on the remote repository once after all the refs have
419-
been updated.
418+
The hook executes on the remote repository once after all the proposed
419+
ref updates are processed and if at least one ref is updated as the
420+
result.
420421

421-
This hook executes once for the receive operation. It takes no
422-
arguments, but gets the same information as the
423-
<<pre-receive,'pre-receive'>>
424-
hook does on its standard input.
422+
The hook takes no arguments. It receives one line on standard input for
423+
each ref that is successfully updated following the same format as the
424+
<<pre-receive,'pre-receive'>> hook.
425425

426426
This hook does not affect the outcome of `git receive-pack`, as it
427427
is called after the real work is done.
@@ -448,6 +448,9 @@ environment variables will not be set. If the client selects
448448
to use push options, but doesn't transmit any, the count variable
449449
will be set to zero, `GIT_PUSH_OPTION_COUNT=0`.
450450

451+
See the "post-receive" section in linkgit:git-receive-pack[1] for
452+
additional details.
453+
451454
[[post-update]]
452455
post-update
453456
~~~~~~~~~~~

0 commit comments

Comments
 (0)