From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jani Nikula <jani.nikula@intel.com>,
Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v2 3/4] scripts/kernel-doc: ensure that comments are using our coding style
Date: Mon, 12 Jan 2026 16:06:52 +0100 [thread overview]
Message-ID: <7604a45e8ade06994afeb68616cf1838dd1101ec.1768229902.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1768229902.git.mchehab+huawei@kernel.org>
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.")
@@ -213,7 +215,9 @@ def main():
action="store_true",
help="Enable line number output (only in ReST mode)")
+ #
# Arguments to control the warning behavior
+ #
parser.add_argument("-Wreturn", "--wreturn", action="store_true",
help="Warns about the lack of a return markup on functions.")
@@ -235,7 +239,9 @@ def main():
parser.add_argument("-export-file", "--export-file", action='append',
help=EXPORT_FILE_DESC)
+ #
# Output format mutually-exclusive group
+ #
out_group = parser.add_argument_group("Output format selection (mutually exclusive)")
@@ -248,7 +254,9 @@ def main():
out_fmt.add_argument("-N", "-none", "--none", action="store_true",
help="Do not output documentation, only warnings.")
+ #
# Output selection mutually-exclusive group
+ #
sel_group = parser.add_argument_group("Output selection (mutually exclusive)")
sel_mut = sel_group.add_mutually_exclusive_group()
@@ -262,7 +270,9 @@ def main():
sel_mut.add_argument("-s", "-function", "--symbol", action='append',
help=FUNCTION_DESC)
+ #
# Those are valid for all 3 types of filter
+ #
parser.add_argument("-n", "-nosymbol", "--nosymbol", action='append',
help=NOSYMBOL_DESC)
@@ -295,9 +305,11 @@ def main():
python_ver = sys.version_info[:2]
if python_ver < (3,6):
+ #
# Depending on Kernel configuration, kernel-doc --none is called at
# build time. As we don't want to break compilation due to the
# usage of an old Python version, return 0 here.
+ #
if args.none:
logger.error("Python 3.6 or later is required by kernel-doc. skipping checks")
sys.exit(0)
@@ -307,7 +319,9 @@ def main():
if python_ver < (3,7):
logger.warning("Python 3.7 or later is required for correct results")
+ #
# Import kernel-doc libraries only after checking Python version
+ #
from kdoc.kdoc_files import KernelFiles # pylint: disable=C0415
from kdoc.kdoc_output import RestFormat, ManFormat # pylint: disable=C0415
@@ -346,6 +360,8 @@ def main():
sys.exit(0)
+#
# Call main method
+#
if __name__ == "__main__":
main()
--
2.52.0
next prev parent reply other threads:[~2026-01-12 15:08 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 ` Mauro Carvalho Chehab [this message]
2026-01-12 15:43 ` [PATCH v2 3/4] scripts/kernel-doc: ensure that comments are using our coding style Jonathan Corbet
2026-01-12 15:57 ` Mauro Carvalho Chehab
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=7604a45e8ade06994afeb68616cf1838dd1101ec.1768229902.git.mchehab+huawei@kernel.org \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®