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

Re: [PATCH v2 3/4] doc: sparse-checkout.adoc: fix asciidoc warnings

From
Elijah Newren <newren@gmail.com>
Date
Oct 8, 2025, 03:57 UTC
Message-ID
<CABPp-BEYF6MdcaXU1qAYctRBAt754j7PGkE3Tgjmm03bBkBjNQ@mail.gmail.com>
In-Reply-To
<20251002221233.541844-4-ramsay@ramsayjones.plus.com>
On Thu, Oct 2, 2025 at 3:13 PM Ramsay Jones <ramsay@ramsayjones.plus.com> wrote:
Show 22 quoted lines
>
> Both asciidoc and asciidoctor issue warnings about 'list item index:
> expected n got n-1' for n=1->7 on lines 928, 931, 951, 974, 980, 1033
> and 1049. 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 17. (asciidoc only complains about the first instance of this,
> while asciidoctor complains about them all, on lines 95, 258, 303, 316,
> 545, 612, 752, 824, 895, 923 and 1053). 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 severn, rather than zero to six. Fortunately, this does not
> require altering additional text, since the enumeration of 'Known Bugs'
> is not referred to anywhere else in the document.
>
> 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 apparent (sub-)titles are
> not marked up with sub-title syntax, so add some '=== ' prefix(s) to the
> relevant headings.

Kinda surprising; if it's complaining about lack of title nesting, I'd think you'd need a '= title =' somewhere before using '== title =='. Maybe jumping skipping one nesting level it's fine with, but skipping two is where the problem starts? No idea.

Show 13 quoted lines
> In addition to the warnings, address some other formatting issues:
>
>   - the use of heavily nested unordered lists is not reflected in the
>     output (making the file totally unreadable) because each level of
>     nesting requires a different syntax. (i.e. replace '*' with '**'
>     for the second level, '*' with '***' for the third level, etc.)
>   - make use of literal blocks and manual indentation to get asciidoc
>     and asciidoctor to display even remotely similar output.
>   - make use of labelled lists, in some places, to get a similar looking
>     output to the input, for both asciidoc and asciidoctor.
>   - replace the trailing space in: `git grep ${SEARCH_TERM} OLDREV `
>     otherwise the entire line in which that appears is removed from
>     the output.

Again, sorry for putting you through all this; I had assumed Documentation/technical/ was stuff meant for other Git developers to see and didn't need to be typeset with asciidoc or asciidoctor and had never attempted to run the documents I added there under either. Someone else renamed them to .adoc...

I skimmed through the document, and it all looked like typesetting changes which don't impair the readability of the source text, so seems fine to me. (Same with the previous patch)

Previous: Ramsay JonesNext: Ramsay Jones
Message 14 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.