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

Re: [PATCH v2 2/4] doc: remembering-renames.adoc: fix asciidoc warnings

From
Elijah Newren <newren@gmail.com>
Date
Oct 8, 2025, 03:51 UTC
Message-ID
<CABPp-BGiziz6-7zyq+Z-f0g+JDPMpGuXanmXNEM=0hV-7jKNsQ@mail.gmail.com>
In-Reply-To
<20251002221233.541844-3-ramsay@ramsayjones.plus.com>
On Thu, Oct 2, 2025 at 3:13 PM Ramsay Jones <ramsay@ramsayjones.plus.com> wrote:
Show 37 quoted lines
>
> Both asciidoc and ascidoctor issue warnings about 'list item index:
> expected n got n-1' for n=1->9 on lines 13, 15, 17, 20, 23, 25, 29,
> 31 and 33. In asciidoc, numbered lists must start at one, whereas this
> file has a list starting at zero. Also, asciidoc and asciidoctor warn
> about 'section title out of sequence: expected level 1, got level 2'
> on line 38. (asciidoc only complains about the first instance of this,
> while asciidoctor complains about them all, on lines 94, 141, 142,
> 184, 185, 257, 288, 289, 290, 397, 424, 485, 486 and 487). These
> warnings stem from the section titles not being correctly nested within
> a document/chapter title.
>
> In order to address the first set of warnings, simply renumber the list
> from one to nine, rather than zero to eight. This also requires altering
> the text which refers to the section numbers, including other section
> titles.
>
> In order to address the second set of warnings, change the section title
> syntax from '=== title ===' to '== title ==', effectively reducing the
> nesting level of the title by one. Also, some of the titles are given
> over multiple lines (they are very long), with an title '===' prefix
> on each line. This leads to them being treated as separate sections
> with no body text (as you can see from the line numbers given for the
> asciidoctor warnings, above). So, for these titles, turn them into a
> single (long) line of text.
>
> In addition to the warnings, address some other formatting issues:
>
>   - the ascii branch diagrams didn't format correctly on asciidoctor
>     so include them in a literal block.
>   - several blocks of text were intended to be formatted 'as is' but
>     were not included in a literal block.
>   - in section 8, format the (A)->(D) in the text description as a
>     literal with `` marks, since (C) is rendered as a copyright
>     symbol in html otherwise.
>   - in section 9, a sub-list of two items is not formatted as such.
>     change the '*' introducer to '**' to correct the sub-list format.

Sorry to put you through all this work. I had no idea the stuff under Documentation/technical/ was ever meant to be run through asciidoc/asciidoctor. The .txt ending didn't hint at anything like this; I mean, sure lots of other files were put through those, but I assumed this directory was just stuff for other Git developers...

> -=== 0. Assumptions ===
> +== 1. Assumptions ==

It doesn't like '===' but is fine with '=='? I'm a bit surprised. If it was about nesting, wouldn't '==' also complain since there is no '=' headers anywhere.

Previous: Ramsay JonesNext: Ramsay Jones
Message 9 of 25 in “technical docs in make build”
  1. 0/4 technical docs in make buildRamsay Jones, Oct 2, 2025
  2. 1/4 doc: add some missing technical documentsRamsay Jones, Oct 2, 2025
  3. Patrick SteinhardtOct 8, 2025
  4. Junio C HamanoOct 8, 2025
  5. Ramsay JonesOct 8, 2025
  6. Junio C HamanoOct 8, 2025
  7. Ramsay JonesOct 8, 2025
  8. 2/4 doc: remembering-renames.adoc: fix asciidoc warningsRamsay Jones, Oct 2, 2025
  9. Elijah NewrenOct 8, 2025
  10. Ramsay JonesOct 8, 2025
  11. 3/4 doc: sparse-checkout.adoc: fix asciidoc warningsRamsay Jones, Oct 2, 2025
  12. Kristoffer HaugsbakkOct 7, 2025
  13. Ramsay JonesOct 7, 2025
  14. Elijah NewrenOct 8, 2025
  15. Ramsay JonesOct 8, 2025
  16. 4/4 doc: commit-graph.adoc: fix up some formattingRamsay Jones, Oct 2, 2025
  17. Ramsay JonesOct 2, 2025
  18. 0/4 technical docs in make buildRamsay Jones, Oct 16, 2025
  19. 1/4 doc: remembering-renames.adoc: fix asciidoc warningsRamsay Jones, Oct 16, 2025
  20. 2/4 doc: sparse-checkout.adoc: fix asciidoc warningsRamsay Jones, Oct 16, 2025
  21. 3/4 doc: commit-graph.adoc: fix up some formattingRamsay Jones, Oct 16, 2025
  22. 4/4 doc: add large-object-promisors.adoc to the docs buildRamsay Jones, Oct 16, 2025
  23. Ramsay JonesOct 17, 2025
  24. Junio C HamanoOct 23, 2025
  25. Ramsay JonesOct 23, 2025

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.