git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] docs: fix literal quoted spaces

From
Junio C Hamano <gitster@pobox.com>
Date
Jun 1, 2017, 02:06 UTC
Message-ID
<xmqqy3tc797p.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<20170531160721.4yimitnyy6pdxkq5@sigill.intra.peff.net>
Jeff King <peff@peff.net> writes:
Show 23 quoted lines
> 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.

Show 5 quoted lines
> (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
Previous: Jeff KingNext: Adam Dinwoodie
Message 3 of 8 in “docs: fix literal quoted spaces”
  1. docs: fix literal quoted spacesAdam Dinwoodie, May 31, 2017
  2. Jeff KingMay 31, 2017
  3. Junio C HamanoJun 1, 2017
  4. Adam DinwoodieJun 1, 2017
  5. docs: fix formatting and grammarAdam Dinwoodie, Jun 1, 2017
  6. Jeff KingJun 1, 2017
  7. Junio C HamanoJun 2, 2017
  8. Jeff KingJun 2, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.