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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 24/07/15 08:46AM, Junio C Hamano wrote:
> Justin Tobler <jltobler@xxxxxxxxx> 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




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux