From: Junio C Hamano <gitster@pobox.com>
To: Jeff King <peff@peff.net>
Cc: Adam Dinwoodie <adam@dinwoodie.org>, git@vger.kernel.org
Subject: Re: [PATCH] docs: fix literal quoted spaces
Date: Thu, 01 Jun 2017 11:06:18 +0900 [thread overview]
Message-ID: <xmqqy3tc797p.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20170531160721.4yimitnyy6pdxkq5@sigill.intra.peff.net> (Jeff King's message of "Wed, 31 May 2017 12:07:21 -0400")
Jeff King <peff@peff.net> writes:
> On Wed, May 31, 2017 at 04:06:24PM +0100, Adam Dinwoodie wrote:
>
>> When compiling the documentation, asciidoc thinks a backtick surrounded
>> by whitespace shouldn't be interpreted as marking the start or end of a
>> literal. In most cases, that's useful behaviour, but in the git-pull
>> documentation the space is clearly intended to be part of the monospace
>> formatted text.
>
> Good catch.
>
>> Instead, use + to avoid asciidoc's literal passthrough, and encode the
>> space as {sp}. In particular, this means asciidoc will correctly detect
>> the end of the monospace formatting, rather than having it continue past
>> the backtick.
>
> In these particular cases, is the space adding anything? Would a simpler
> fix be to just use:
>
> ...the value on `URL:` line
>
> We've had such headaches with other entities like {sp} between different
> asciidoc versions (not to mention asciidoctor) that I tend to reach for
> the simplest solution.
Me, too (and no, I am not from AOL). If `URL:` is typeset correctly
the approach to drop the space is much more preferred.
> (I'd also suggest the minor English correct of saying "_the_ URL line";
> that's orthogonal to what you're trying to fix, but may make sense on
> top while we're here).
>
> -Peff
next prev parent reply other threads:[~2017-06-01 2:06 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-31 15:06 [PATCH] docs: fix literal quoted spaces Adam Dinwoodie
2017-05-31 16:07 ` Jeff King
2017-06-01 2:06 ` Junio C Hamano [this message]
2017-06-01 9:55 ` Adam Dinwoodie
2017-06-01 10:37 ` [PATCH v2] docs: fix formatting and grammar Adam Dinwoodie
2017-06-01 15:53 ` Jeff King
2017-06-02 1:45 ` Junio C Hamano
2017-06-02 2:07 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqy3tc797p.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=adam@dinwoodie.org \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).