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

Re: [PATCH v1 1/2] Documentation/rev-list-options: wrap --date=<format> block with "--"

From
Jeff King <peff@peff.net>
Date
Apr 1, 2019, 13:08 UTC
Message-ID
<20190401130804.GA11664@sigill.intra.peff.net>
In-Reply-To
<20190330183001.16624-2-tmz@pobox.com>
On Sat, Mar 30, 2019 at 02:30:00PM -0400, Todd Zullinger wrote:
Show 8 quoted lines
> Using "+" to continue multiple list items is more tedious and
> error-prone than wrapping the entire block with "--" block markers.
> 
> When using asciidoctor, the list items after the --date=iso list items
> are incorrectly formatted when using "+" continuation.  Use "--" block
> markers to correctly format the block.
> 
> When using asciidoc there is no change in how the content is rendered.

This seems like an asciidoctor bug, though I think this kind of list-within-a-list stuff is inherently a bit heuristic-driven just due to the syntax.

I do agree that the result after your patch is more readable, so I think I prefer it even if the asciidoctor bug were fixed. I suspect we could be using "--" blocks for readability in more places (I don't think it's worth going on a hunt to convert old spots, but something to keep in mind as we write new documentation).

-Peff
Previous: Todd ZullingerNext: Todd Zullinger
Message 8 of 23 in “minor asciidoc/tor formatting fixes”
  1. 0/2 minor asciidoc/tor formatting fixesTodd Zullinger, Mar 30, 2019
  2. 2/2 Documentation/git-status: fix titles in porcelain v2 sectionTodd Zullinger, Mar 30, 2019
  3. Jeff KingApr 1, 2019
  4. Todd ZullingerApr 5, 2019
  5. Jeff HostetlerApr 3, 2019
  6. Todd ZullingerApr 5, 2019
  7. 1/2 Documentation/rev-list-options: wrap --date=<format> block with "--"Todd Zullinger, Mar 30, 2019
  8. Jeff KingApr 1, 2019
  9. Todd ZullingerApr 5, 2019
  10. Martin ÅgrenApr 3, 2019
  11. Todd ZullingerApr 5, 2019
  12. Martin ÅgrenApr 5, 2019
  13. 0/2 a few more minor asciidoc/tor formatting fixesTodd Zullinger, Apr 5, 2019
  14. Martin ÅgrenApr 6, 2019
  15. 1/2 Documentation/git-show-branch: avoid literal {apostrophe}Todd Zullinger, Apr 10, 2019
  16. 2/2 Documentation/git-svn: improve asciidoctor compatibilityTodd Zullinger, Apr 10, 2019
  17. 0/2 a few more minor asciidoc/tor formatting fixesTodd Zullinger, Apr 10, 2019
  18. Junio C HamanoApr 10, 2019
  19. 1/2 Documentation/git-show-branch: drop last use of {apostrophe}Todd Zullinger, Apr 5, 2019
  20. Martin ÅgrenApr 6, 2019
  21. 2/2 Documentation/git-svn: improve asciidoctor compatibilityTodd Zullinger, Apr 5, 2019
  22. Martin ÅgrenApr 6, 2019
  23. Todd ZullingerApr 10, 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.