Re: [PATCH v2] doc: clarify post-receive hook behavior

From: Justin Tobler <jltobler@gmail.com>
Date: Jul 15, 2024, 18:22 UTC
Message-ID: <dzdoaldgm5sk25ll57okroqcnhqurtoqmo7d5xsjnrjpgveqzx@63w4uav6jtd6>
In-Reply-To: <xmqqfrsa7j4p.fsf@gitster.g>

On 24/07/15 08:46AM, Junio C Hamano wrote:

Show 9 quoted lines

> 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