Thread (22 messages) 22 messages, 5 authors, 18d ago

Re: [PATCH] doc: add more AsciiDoc cross-references

flat view

From: Kristoffer Haugsbakk <hidden>
Date: 2026-09-23 19:07:08

On Tue, Sep 22, 2026, at 21:29, Julia Evans via GitGitGadget wrote:
From: Julia Evans <redacted>

Instead of saying "see EXAMPLES below", say "see <<EXAMPLES,EXAMPLES>>
below" to make the man pages easier to navigate on the web.

The reason for using the more verbose <<EXAMPLES,EXAMPLES>>
(instead of <<EXAMPLES>>) is that if the header that `<<EXAMPLES>>`
is referring to is in an included page (for example `REMOTES` in the
`git-push` man page), then AsciiDoc will think it's a broken link even
though it isn't. So it's easier to just make all of the links use the
form with two parts.

Signed-off-by: Julia Evans <redacted>
---
[snip]
Now that I’ve read this commit message, it seems like an obvious idea
in hindsight.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help