From: Brian Norris <briannorris@chromium.org>
To: Dwaipayan Ray <dwaipayanray1@gmail.com>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Joe Perches <joe@perches.com>,
Randy Dunlap <rdunlap@infradead.org>,
workflows@vger.kernel.org,
Brian Norris <briannorris@chromium.org>
Subject: [PATCH v2 1/2] docs: checkpatch: Align block comment style
Date: Fri, 17 Oct 2025 13:37:11 -0700 [thread overview]
Message-ID: <20251017203719.1554224-1-briannorris@chromium.org> (raw)
Ironically, the block style comments in the checkpatch documentation are
not aligned properly. Correct that.
Signed-off-by: Brian Norris <briannorris@chromium.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
---
Changes in v2:
* Add Randy's Reviewed/Tested-by
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
--
2.51.0.858.gf9c4a03a3a-goog
next reply other threads:[~2025-10-17 20:37 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-17 20:37 Brian Norris [this message]
2025-10-17 20:37 ` [PATCH v2 2/2] docs: checkpatch: Drop networking " Brian Norris
2025-10-17 21:16 ` Randy Dunlap
2025-10-18 1:31 ` [PATCH v2 1/2] docs: checkpatch: Align block " Joe Perches
2025-10-21 20:42 ` Jonathan Corbet
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=20251017203719.1554224-1-briannorris@chromium.org \
--to=briannorris@chromium.org \
--cc=corbet@lwn.net \
--cc=dwaipayanray1@gmail.com \
--cc=joe@perches.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=rdunlap@infradead.org \
--cc=workflows@vger.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