From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
linux-kernel@vger.kernel.org,
Jani Nikula <jani.nikula@intel.com>
Subject: Re: [PATCH v2 3/4] scripts/kernel-doc: ensure that comments are using our coding style
Date: Mon, 12 Jan 2026 16:57:10 +0100 [thread overview]
Message-ID: <aWUXVv1nt4Npjznw@foz.lan> (raw)
In-Reply-To: <878qe23kgv.fsf@trenco.lwn.net>
On Mon, Jan 12, 2026 at 08:43:28AM -0700, Jonathan Corbet wrote:
> Mauro Carvalho Chehab <mchehab+huawei@kernel.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@kernel.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
next prev parent reply other threads:[~2026-01-12 15:57 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-12 15:06 [PATCH v2 0/4] fix -Werror issues Mauro Carvalho Chehab
2026-01-12 15:06 ` [PATCH v2 1/4] scripts/kernel-doc: fix logic to handle unissued warnings Mauro Carvalho Chehab
2026-01-12 15:06 ` [PATCH v2 2/4] scripts/kernel-doc: avoid error_count overflows Mauro Carvalho Chehab
2026-01-12 15:06 ` [PATCH v2 3/4] scripts/kernel-doc: ensure that comments are using our coding style Mauro Carvalho Chehab
2026-01-12 15:43 ` Jonathan Corbet
2026-01-12 15:57 ` Mauro Carvalho Chehab [this message]
2026-01-12 15:06 ` [PATCH v2 4/4] scripts/kernel-doc: some fixes to kernel-doc comments Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aWUXVv1nt4Npjznw@foz.lan \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.