From: "Martin Ågren" <martin.agren@gmail.com>
To: Todd Zullinger <tmz@pobox.com>
Cc: "Git Mailing List" <git@vger.kernel.org>,
"brian m. carlson" <sandals@crustytoothpaste.net>,
"Jeff King" <peff@peff.net>,
"SZEDER Gábor" <szeder.dev@gmail.com>
Subject: Re: [PATCH 1/2] Documentation/git-show-branch: drop last use of {apostrophe}
Date: Sat, 6 Apr 2019 11:21:22 +0200 [thread overview]
Message-ID: <CAN0heSoNNb4QLqQfkgPZRBD2TJ3h1JM3udyRyHnuoOcWbe94Zg@mail.gmail.com> (raw)
In-Reply-To: <20190405225115.3882-2-tmz@pobox.com>
On Sat, 6 Apr 2019 at 00:51, Todd Zullinger <tmz@pobox.com> wrote:
>
> The {apostrophe} was needed at the time of a521845800 ("Documentation:
> remove stray backslash in show-branch discussion", 2010-08-20). All
> other uses of {apostrophe} were removed in 6cf378f0cb ("docs: stop using
> asciidoc no-inline-literal", 2012-04-26).
>
> Escape only the leading single-quote. This renders properly in asciidoc
> and asciidoctor.
You could perhaps say that "{apostrophe}" renders literally with
Asciidoctor (at least with 1.5.5). Right now, you sort of undersell this
patch. I know from context that you have some Asciidoctor "issue", but
it's not clear from this patch alone.
> ---
>
> Maybe it would be easier to change the example commit messages
> and avoid having to nest single quotes within double quotes? I
> don't know if that's much preferable to escaping only the opening
> single quote.
Yeah, those commit messages are a bit unfortunate from the point of view
of quoting. Avoiding all that nesting would probably improve the reading
experience, but I don't think that should hold up this patch.
> This is another potential parsing bug in asciidoctor. Of course,
> distros will have versions of asciidoctor in place for some time
> which have trouble parsing this doc. Since it's not much work
> for us to adjust the text to work around it, that seemed
> reasonable.
Agreed.
Martin
next prev parent reply other threads:[~2019-04-06 9:21 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-30 18:29 [PATCH v1 0/2] minor asciidoc/tor formatting fixes Todd Zullinger
2019-03-30 18:30 ` [PATCH v1 1/2] Documentation/rev-list-options: wrap --date=<format> block with "--" Todd Zullinger
2019-04-01 13:08 ` Jeff King
2019-04-05 1:20 ` Todd Zullinger
2019-03-30 18:30 ` [PATCH v1 2/2] Documentation/git-status: fix titles in porcelain v2 section Todd Zullinger
2019-04-01 13:18 ` Jeff King
2019-04-05 1:26 ` Todd Zullinger
2019-04-03 8:49 ` Jeff Hostetler
2019-04-05 1:32 ` Todd Zullinger
2019-04-03 9:26 ` [PATCH v1 0/2] minor asciidoc/tor formatting fixes Martin Ågren
2019-04-05 1:40 ` Todd Zullinger
2019-04-05 10:23 ` Martin Ågren
2019-04-05 22:51 ` [PATCH 0/2] a few more " Todd Zullinger
2019-04-06 9:16 ` Martin Ågren
2019-04-10 0:37 ` [PATCH v2 " Todd Zullinger
2019-04-10 3:09 ` Junio C Hamano
2019-04-10 0:37 ` [PATCH v2 1/2] Documentation/git-show-branch: avoid literal {apostrophe} Todd Zullinger
2019-04-10 0:37 ` [PATCH v2 2/2] Documentation/git-svn: improve asciidoctor compatibility Todd Zullinger
2019-04-05 22:51 ` [PATCH 1/2] Documentation/git-show-branch: drop last use of {apostrophe} Todd Zullinger
2019-04-06 9:21 ` Martin Ågren [this message]
2019-04-05 22:51 ` [PATCH 2/2] Documentation/git-svn: improve asciidoctor compatibility Todd Zullinger
2019-04-06 9:31 ` Martin Ågren
2019-04-10 0:41 ` Todd Zullinger
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=CAN0heSoNNb4QLqQfkgPZRBD2TJ3h1JM3udyRyHnuoOcWbe94Zg@mail.gmail.com \
--to=martin.agren@gmail.com \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
--cc=sandals@crustytoothpaste.net \
--cc=szeder.dev@gmail.com \
--cc=tmz@pobox.com \
/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).