Re: [PATCH] doc: add more AsciiDoc cross-references
- From
- Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
- Date
- Sep 23, 2026, 19:06 UTC
- Message-ID
- <7532313e-4705-4e2f-b36d-f2329d70ac6a@app.fastmail.com>
- In-Reply-To
- <pull.2416.git.git.1790105342890.gitgitgadget@gmail.com>
On Tue, Sep 22, 2026, at 21:29, Julia Evans via GitGitGadget wrote:
Show 15 quoted lines
> From: Julia Evans <julia@jvns.ca> > > 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 <julia@jvns.ca> > --- >[snip]
Now that I’ve read this commit message, it seems like an obvious idea in hindsight.