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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Thu, 29 Feb 2024 16:52:41 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: lukas.bulwahn@...il.com
Cc: corbet@....net, jani.nikula@...el.com, kernel-janitors@...r.kernel.org,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 rdunlap@...radead.org, workflows@...r.kernel.org,
 Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH v2 3/3] docs: submit-checklist: change to autonumbered
 lists

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@...il.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@...il.com>

        Thanks, Akira