Re: [PATCH v2 3/3] docs: submit-checklist: change to autonumbered lists

Akira Yokosawa
2024-02-29T07:52:40Z

Hi Lukas,

I might be nitpicking too much, but let me go ahead...

On Thu, 29 Feb 2024 04:07:43 +0100, Lukas Bulwahn wrote:
> During review (see Link), Jani Nikula suggested to use autonumbered
> lists instead of manually-maintained bullet numbering.
>
> Turn all lists into autonumbered lists.
>
> Link: https://lore.kernel.org/linux-doc/87o7c3mlwb.fsf@intel.com/
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> ---
> Documentation/process/submit-checklist.rst | 48 +++++++++++-----------
> 1 file changed, 24 insertions(+), 24 deletions(-)
>
> diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst
> index e531dd504b6c..c984b747a755 100644
> --- a/Documentation/process/submit-checklist.rst
> +++ b/Documentation/process/submit-checklist.rst
> @@ -14,62 +14,62 @@ and elsewhere regarding submitting Linux kernel patches.
> Review your code
> ================
>
> -1) If you use a facility then #include the file that defines/declares
> +#. If you use a facility then #include the file that defines/declares
> that facility. Don't depend on other header files pulling in ones
> that you use.

Wait. This will render the list starting from:

1. If you use ...

In patch 1/1, you didn't change the ")".

It was Jani who suggested "#.", but "#)" would work just fine.

For details, see docutils' documentation at:

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#enumerated-lists

By the way, you should be able to use auto enumeration in the 2nd-level
list as well.

> @@ -77,7 +77,7 @@ Check your code with tools
> Build your code
> ===============
>
> -1) Builds cleanly:
> +#. Builds cleanly:
>
> a) with applicable or modified ``CONFIG`` options ``=y``, ``=m``, and
> ``=n``. No ``gcc`` warnings/errors, no linker warnings/errors.

While the first item needs "a)", subsequent items can use "#)".

Either way,

Reviewed-by: Akira Yokosawa <akiyks@gmail.com>

Thanks, Akira