| Message ID | 20240714194626.29512-2-jltobler@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v2] doc: clarify post-receive hook behavior | expand |
Justin Tobler <jltobler@gmail.com> writes: > +See the link:git-receive-pack.html#_post_receive_hook[post-receive hook] > +section in linkgit:git-receive-pack[1] for additional details. Use of link:*.html to point to the HTML version of the manual page is questionable. Do we have any example that uses such a link already? What would this line do to those who read the manual page, not HTML, iow, "git receive-pack --help -m"? The latter link using linkgit: is bog standard and perfectly fine. Thanks.
On 24/07/15 08:46AM, Junio C Hamano wrote: > Justin Tobler <jltobler@gmail.com> writes: > > > +See the link:git-receive-pack.html#_post_receive_hook[post-receive hook] > > +section in linkgit:git-receive-pack[1] for additional details. > > Use of link:*.html to point to the HTML version of the manual page > is questionable. Do we have any example that uses such a link > already? What would this line do to those who read the manual page, > not HTML, iow, "git receive-pack --help -m"? The manual page for git(1) makes use of link:*.html to point to HTML documentation. - Documentation/git.txt - https://git-scm.com/docs/git In the manual page it appears to specify a path to HTML file in the NOTES section. I'm not sure this is a good thing though because the file cannot be expected to exist at the path. > The latter link using linkgit: is bog standard and perfectly fine. I think it makes the most sense to drop the link:*html used here and just rely on the linkgit: reference. I'll adjust this in v3. Thanks for the feedback. -Justin
Justin Tobler <jltobler@gmail.com> writes: > I think it makes the most sense to drop the link:*html used here and > just rely on the linkgit: reference. I'll adjust this in v3. Thanks for > the feedback. That sounds like a sensible and conservative approach. Thanks.
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 06e997131b..5459a40326 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 link:git-receive-pack.html#_post_receive_hook[post-receive hook] +section in linkgit:git-receive-pack[1] for additional details. + [[post-update]] post-update ~~~~~~~~~~~
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> --- Greetings again, This is the second version of my patch for post-receive hook documentation updates. Thanks again for taking a look. -Justin Changes from v1: - Removed repetivitve statement about the hook being executed once. - Slightly reworded statements to improve clarity. Range-diff against v1: 1: e4824ba60d ! 1: 747e925dfc doc: clarify post-receive hook behavior @@ Documentation/githooks.txt: post-receive `git push` and updates reference(s) in its repository. -It executes on the remote repository once after all the refs have -been updated. -+It executes on the remote repository once if any of the attempted ref -+updates are successful. ++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. -+For a receive operation, this hook executes a single time at most. It -+takes no arguments, but for each ref successfully updated, it receives a -+line on standard input that follows the same format as the ++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 Documentation/githooks.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) base-commit: a7dae3bdc8b516d36f630b12bb01e853a667e0d9