Re: [PATCH v3 1/2] Documentation: fix linkgit references
- From
Jeff King <peff@peff.net>
- Date
- May 2, 2016, 20:34 UTC
- Message-ID
- <20160502203445.GA19509@sigill.intra.peff.net>
- In-Reply-To
- <1462220405-12408-2-git-send-email-larsxschneider@gmail.com>
On Mon, May 02, 2016 at 10:20:04PM +0200, larsxschneider@gmail.com wrote:
> From: Lars Schneider <larsxschneider@gmail.com> > > Signed-off-by: Lars Schneider <larsxschneider@gmail.com> > ---
Fix how? Your commit message doesn't say why this is a good idea. Since this is v3, I'm guessing that reasoning is on the list, but it needs to be summarized here in the commit message.
Show 10 quoted lines
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index c7bbe98..c5f1d6b 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -894,7 +894,7 @@ branch.<name>.description::
> browser.<tool>.cmd::
> Specify the command to invoke the specified browser. The
> specified command is evaluated in shell with the URLs passed
> - as arguments. (See linkgit:git-web{litdd}browse[1].)
> + as arguments. (See linkgit:git-web--browse[1].)The existing code renders fine for me with "make git-config.1". But with your patch, I get a unicode emdash, which is wrong:
--- old 2016-05-02 16:27:53.242050262 -0400 +++ new 2016-05-02 16:27:57.742050360 -0400
@@ -978,7 +978,7 @@ browser.<tool>.cmd Specify the command to invoke the specified browser. The specified command is evaluated in shell with the - URLs passed as arguments. (See git-web--browse(1).) + URLs passed as arguments. (See git-web—browse(1).) browser.<tool>.path Override the path for the given tool that may be used to browse HTML help (see -w option in git-help(1)) In case it's hard to see with your font, the generated roff looks like this: -\fBgit-web--browse\fR(1)\&.) +\fBgit-web\(embrowse\fR(1)\&.) 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). -Peff