From: Todd Zullinger <tmz@pobox.com>
To: "Martin Ågren" <martin.agren@gmail.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: [PATCH v2 0/2] a few more minor asciidoc/tor formatting fixes
Date: Tue, 9 Apr 2019 20:37:32 -0400 [thread overview]
Message-ID: <20190410003734.17124-1-tmz@pobox.com> (raw)
In-Reply-To: <CAN0heSrPx+_dB+NZzRzidZFpfLMpQUHk-Wi8rTaer+stam0NPA@mail.gmail.com>
Hi,
Martin Ågren wrote:
> On Sat, 6 Apr 2019 at 00:51, Todd Zullinger <tmz@pobox.com> wrote:
>> Here's what I have currently. I haven't tested this much with
>> asciidoctor-1.5.x releases (or maybe not at all -- it's been a
>> week or so since I worked on this).
>
> Tested with Asciidoctor 1.5.5. For both patches, AsciiDoctor stumbles
> before the patch, but not after it. Great. :-) For AsciiDoc 8.6.10, the
> first patch is a no-op, while the second patch makes the difference it
> intends to do. I'll follow up with comments on the individual patches.
Thanks for testing these against older Asciidoctor and for the
helpful feedback on the commit messages.
I reworded the message in the first commit to make it clearer
that Asciidoctor renders the {apostrophe} literally. I updated
the body of the second commit using your suggested wording. It
was much better than the original. :)
The contents of each commit remain unchanged.
Todd Zullinger (2):
Documentation/git-show-branch: avoid literal {apostrophe}
Documentation/git-svn: improve asciidoctor compatibility
Documentation/git-show-branch.txt | 2 +-
Documentation/git-svn.txt | 6 +++---
2 files changed, 4 insertions(+), 4 deletions(-)
Range-diff against v1:
1: 70e3339859 ! 1: da553a596c Documentation/git-show-branch: drop last use of {apostrophe}
@@ -1,14 +1,17 @@
Author: Todd Zullinger <tmz@pobox.com>
- Documentation/git-show-branch: drop last use of {apostrophe}
+ Documentation/git-show-branch: avoid literal {apostrophe}
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.
+ Unfortunately, the {apostrophe} is rendered literally with Asciidoctor
+ (at least with 1.5.5-2.0.3). Avoid this by using single-quotes.
+
+ Escaping the leading single-quote allows the content to render properly
+ in AsciiDoc and Asciidoctor.
Signed-off-by: Todd Zullinger <tmz@pobox.com>
2: e8f6f873bc ! 2: 6fd412bd97 Documentation/git-svn: improve asciidoctor compatibility
@@ -3,8 +3,18 @@
Documentation/git-svn: improve asciidoctor compatibility
The second paragraph in the CONFIGURATION section intends to emphasize
- the word 'must' with bold type. Adjust the formatting slightly to
- provide similar results between asciidoc and asciidoctor.
+ the word 'must' with bold type. It does so by writing it as *must*, and
+ this works fine with AsciiDoc. It usually works great with Asciidoctor,
+ too, but in this particular instance, we have another "*" earlier in the
+ paragraph. We do escape it, and it is rendered literally just like we
+ want it to, but Asciidoctor then ends up tripping on the second (or
+ third) of the asterisks in this paragraph.
+
+ Since that asterisk is (part of) a literal example, we can set it in
+ monospace, by giving it as `*`. Adjust the whole paragraph in this way.
+ There's lots more monospacing to be done in this document, but since our
+ main motivation is addressing AsciiDoc/Asciidoctor discrepancies like
+ this one, let's just convert this one paragraph.
Signed-off-by: Todd Zullinger <tmz@pobox.com>
--
Todd
next prev parent reply other threads:[~2019-04-10 0:37 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 ` Todd Zullinger [this message]
2019-04-10 3:09 ` [PATCH v2 " 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
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=20190410003734.17124-1-tmz@pobox.com \
--to=tmz@pobox.com \
--cc=git@vger.kernel.org \
--cc=martin.agren@gmail.com \
--cc=peff@peff.net \
--cc=sandals@crustytoothpaste.net \
--cc=szeder.dev@gmail.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).