Re: [PATCH v3 1/2] Documentation: fix linkgit references
- From
Jeff King <peff@peff.net>
- Date
- May 3, 2016, 17:58 UTC
- Message-ID
- <20160503175808.GA29877@sigill.intra.peff.net>
- In-Reply-To
- <E4A56B4E-6F2E-44E3-870B-D1D3A71B2869@gmail.com>
On Tue, May 03, 2016 at 10:30:09AM +0200, Lars Schneider wrote:
Show 9 quoted lines
> > So I think that's a step backwards. I did check the asciidoctor
> > rendering on git-scm.com, though, and it gets the {litdd} case wrong. So
> > I think it does need fixing, but we need a solution that looks correct
> > in both cases. Maybe linkgit:`git-web--browse`[1] would work; it seems
> > OK with my version of asciidoc, but I have a feeling it will run into
> > the same problem with asciidoctor (if it's not respecting {litdd} in
> > that context, it's probably also not respecting backticks).
> I will play with this to find a solution. Would it be an option to
> replace "--" with "-"? Why do we need two dashes if they cause trouble?We use two dashes to signify "internal" programs that users should not rely on. So "git-web-browse" would be something we'd expect to support forever, but "git-web--browse" is an implementation detail of one of our scripts (that just happens to require an extra program).
So I don't think we want to switch away from that convention just to make the documentation work.
AFAICT, the {litdd} is working fine with asciidoc; it's only asciidoctor that is the problem. So the first step may be talking with asciidoctor folks to see if it's a bug, or if they have a recommended workaround.
-Peff