linux-kernel - Re: [PATCH] docs: checkpatch: Align block comment style

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] [day] [month] [year] [list]

Message-ID: <b71d9455-610a-40d7-af3e-f030499dd2a0@infradead.org>
Date: Fri, 17 Oct 2025 12:39:36 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Brian Norris <briannorris@...omium.org>,
 Dwaipayan Ray <dwaipayanray1@...il.com>,
 Lukas Bulwahn <lukas.bulwahn@...il.com>, Jonathan Corbet <corbet@....net>
Cc: workflows@...r.kernel.org, linux-kernel@...r.kernel.org,
 linux-doc@...r.kernel.org, Joe Perches <joe@...ches.com>
Subject: Re: [PATCH] docs: checkpatch: Align block comment style



On 10/17/25 11:02 AM, Brian Norris wrote:
> Ironically, the block style comments in the checkpatch documentation are
> not aligned properly. Correct that.
> 
> Signed-off-by: Brian Norris <briannorris@...omium.org>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

However, I would just remove the entire second comment block and
its lead-in comment.
Networking no longer has its own comment style and it looks like
checkpatch no longer checks for that.


> ---
> 
>  Documentation/dev-tools/checkpatch.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
> index d5c47e560324..d7fe023b3080 100644
> --- a/Documentation/dev-tools/checkpatch.rst
> +++ b/Documentation/dev-tools/checkpatch.rst
> @@ -461,16 +461,16 @@ Comments
>      line comments is::
>  
>        /*
> -      * This is the preferred style
> -      * for multi line comments.
> -      */
> +       * This is the preferred style
> +       * for multi line comments.
> +       */
>  
>      The networking comment style is a bit different, with the first line
>      not empty like the former::
>  
>        /* This is the preferred comment style
> -      * for files in net/ and drivers/net/
> -      */
> +       * for files in net/ and drivers/net/
> +       */
>  
>      See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting
>  

-- 
~Randy