Web lists-archives.com

[PATCH v2 0/2] a few more minor asciidoc/tor formatting fixes


Martin Ågren wrote:
> On Sat, 6 Apr 2019 at 00:51, Todd Zullinger <tmz@xxxxxxxxx> 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@xxxxxxxxx>
    -    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@xxxxxxxxx>
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@xxxxxxxxx>