Re: [Buildroot] [PATCH 2/6 v2] doc/manual: fixup ordered lists

[Peter Korsgaard <peter@korsgaard.com>]

>>>>> "Yann" == Yann E MORIN <yann.morin.1998@free.fr> writes:

 > With recent asiidoc versions (at least 10.2.0 is known to report that),
 > rendering the manual yields a few warnings related to ordered lists:

 >     asciidoc: WARNING: customize-quick-guide.adoc: line 13: list item index: expected 2 got 1
 >     asciidoc: WARNING: customize-quick-guide.adoc: line 15: list item index: expected 3 got 1
 >     [...]
 >     asciidoc: WARNING: customize-quick-guide.adoc: line 65: list item index: expected 13 got 1
 >     asciidoc: WARNING: customize-quick-guide.adoc: line 66: list item index: expected 14 got 1
 >     asciidoc: WARNING: adding-packages-gettext.adoc: line 30: list item index: expected 2 got 1
 >     asciidoc: WARNING: adding-packages-gettext.adoc: line 41: list item index: expected 3 got 1

 > The reason is that we use the same index to tell asciidoc to
 > automatically number items.

 > However, the official way to provide an automatic index is to write no
 > index:

 >     https://docs.asciidoctor.org/asciidoc/latest/lists/ordered/

 >     [...] since the numbering is obvious, the AsciiDoc processor will
 >     insert the numbers for you if you omit them:
 >     [...]
 >     If you number the ordered list explicitly, you have to manually keep
 >     the list numerals sequential. Otherwise, you will get a warning.

 > So, abide by the documentation, and drop the repeating indices to
 > ordered lists where we want automatic numbering.

 > Note that there is another ordered list, in adding-packages-directory.adoc,
 > but it does use explicit, sequential numbering. For consistency within
 > the whole document, we also convert it.

 > To avoid extra useless churn, the indentation of the items is not
 > changed to match the elided indices.

 > Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>

Committed to 2023.02.x and 2023.11.x, thanks.

-- 
Bye, Peter Korsgaard
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot