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

Re: [PATCH 0/7] Fix more AsciiDoc/tor differences

From
Jeff King <peff@peff.net>
Date
Sep 13, 2019, 04:48 UTC
Message-ID
<20190913044828.GA21172@sigill.intra.peff.net>
In-Reply-To
<cover.1567707999.git.martin.agren@gmail.com>
On Sat, Sep 07, 2019 at 04:12:46PM +0200, Martin Ågren wrote:
> This series roughly halves the line count of `./doc-diff --from-asciidoc
> --to-asciidoctor --cut-header-footer HEAD HEAD`. Together with my recent
> (independent) mini-series [1], I claim that Asciidoctor 1.5.5 now
> processes the manpages better than AsciiDoc 8.6.10 does.

I looked these over, both source and rendered output (both with asciidoc and with asciidoctor 2.0.10), and they all look good to me.

I think the delimited literal blocks are _slightly_ less pretty than the indented ones, but this is the solution we've been using for cross-tool compatibility (and I think it's intentional in asciidoctor to deprecate the indented blocks, because there are just too many corner cases). The delimited ones are also easier to write correctly.

Show 5 quoted lines
> Patch 6/7 actually changes the rendering with both engines, so that they
> look nice and the same. The other patches are all no-ops with one engine
> while fixing things with the other -- they all improve the situation
> with Asciidoctor (which is what I care most about) except patch 1/7
> which goes the other way (it reduces the doc-diff, which helps).

Yeah, I agree that the change in 6/7 is an improvement (and 1/7 is an obvious bugfix looking at the doc-diff using just asciidoc).

Show 5 quoted lines
> Patch 7/7 has an element of black magic to it. I wouldn't be too
> surprised if I've managed to appease my particular versions of these
> tools while not fixing -- or maybe even breaking? -- some other versions
> [that people actually use]. That's where I think a quick test would be
> the most valuable.

I can confirm that asciidoctor 2.0.10 has the same bogus output there before your patches, and that 7/7 fixes it.

-Peff
Previous: Martin ÅgrenNext: Martin Ågren
Message 9 of 10 in “Fix more AsciiDoc/tor differences”
  1. 0/7 Fix more AsciiDoc/tor differencesMartin Ågren, Sep 7, 2019
  2. 4/7 git-ls-remote.txt: wrap shell listing in "----"Martin Ågren, Sep 7, 2019
  3. 1/7 Documentation: wrap blocks with "--"Martin Ågren, Sep 7, 2019
  4. 3/7 Documentation: wrap config listings in "----"Martin Ågren, Sep 7, 2019
  5. 2/7 git-merge-base.txt: render indentations correctly under AsciidoctorMartin Ågren, Sep 7, 2019
  6. 5/7 git-receive-pack.txt: wrap shell [script] listing in "----"Martin Ågren, Sep 7, 2019
  7. 7/7 gitweb.conf.txt: switch pluses to backticks to help AsciidoctorMartin Ågren, Sep 7, 2019
  8. 6/7 git-merge-index.txt: wrap shell listing in "----"Martin Ågren, Sep 7, 2019
  9. Jeff KingSep 13, 2019
  10. Martin ÅgrenSep 13, 2019

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.