linux-kernel - Re: [PATCH v2 3/4] scripts/kernel-doc: ensure that comments are using our coding 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 for Android: free password hash cracker in your pocket

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

Message-ID: <aWUXVv1nt4Npjznw@foz.lan>
Date: Mon, 12 Jan 2026 16:57:10 +0100
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Jonathan Corbet <corbet@....net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, 
	Linux Doc Mailing List <linux-doc@...r.kernel.org>, Mauro Carvalho Chehab <mchehab@...nel.org>, 
	linux-kernel@...r.kernel.org, Jani Nikula <jani.nikula@...el.com>
Subject: Re: [PATCH v2 3/4] scripts/kernel-doc: ensure that comments are
 using our coding style

On Mon, Jan 12, 2026 at 08:43:28AM -0700, Jonathan Corbet wrote:
> Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:
> 
> > Along kernel-doc libs, we opted to have all comments starting/ending
> > with a blank comment line. Use the same style here.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> > ---
> >  scripts/kernel-doc.py | 16 ++++++++++++++++
> >  1 file changed, 16 insertions(+)
> >
> > diff --git a/scripts/kernel-doc.py b/scripts/kernel-doc.py
> > index 5d2f29e90ebe..7ccee4626478 100755
> > --- a/scripts/kernel-doc.py
> > +++ b/scripts/kernel-doc.py
> > @@ -197,7 +197,9 @@ def main():
> >      parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter,
> >                                       description=DESC)
> >  
> > +    #
> >      # Normal arguments
> > +    #
> >  
> >      parser.add_argument("-v", "-verbose", "--verbose", action="store_true",
> >                          help="Verbose output, more warnings and other information.")
> 
> [nit] I approve of this kind of change, but I would get rid of the extra
> blank lines, just like we do with C code.

Ok. FYI, this is mostly to preserve the same coding style everywhere,
and we did a similar change at kdoc libs. At the initial versions of patch 2,
I wrote a new comment about why we needed to avoid error code > 255.

At v2, we're using a different approach, so no new comments are needed.

> (I wouldn't redo the series just for this).

Patch 4 depends on it, so what I can do - assuming that v2 doesn't need
rebase - is to send you a new patch to drop it extra blank lines.
Or, if this series needs another rebase, I'll fold such changes on it
for the next version.

> 
> Thanks,
> 
> jon

-- 
Thanks,
Mauro