[PATCH v2 1/2] docs: checkpatch: Align block comment style

[PATCH v2 1/2] docs: checkpatch: Align block comment style

[Brian Norris]

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

[PATCH v2 2/2] docs: checkpatch: Drop networking comment style

[Brian Norris]

Networking no longer has their own comment style, and checkpatch no
longer checks for this.

Signed-off-by: Brian Norris <briannorris@chromium.org>
Suggested-by: Randy Dunlap <rdunlap@infradead.org>
---

Changes in v2:
 * new in v2

 Documentation/dev-tools/checkpatch.rst | 7 -------
 1 file changed, 7 deletions(-)

diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index d7fe023b3080..dfaad0a279ff 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -465,13 +465,6 @@ Comments
        * 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/
-       */
-
     See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting
 
   **C99_COMMENTS**
-- 
2.51.0.858.gf9c4a03a3a-goog

Re: [PATCH v2 2/2] docs: checkpatch: Drop networking comment style

[Randy Dunlap]

On 10/17/25 1:37 PM, Brian Norris wrote:
> Networking no longer has their own comment style, and checkpatch no
> longer checks for this.
> 
> Signed-off-by: Brian Norris <briannorris@chromium.org>
> Suggested-by: Randy Dunlap <rdunlap@infradead.org>

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

and for reference:

commit 82b8000c28b5
Author: Johannes Berg <johannes.berg@intel.com>
Date:   Mon Aug 19 11:09:43 2024 +0200
    net: drop special comment style


Thanks.

> ---
> 
> Changes in v2:
>  * new in v2
> 
>  Documentation/dev-tools/checkpatch.rst | 7 -------
>  1 file changed, 7 deletions(-)
> 
> diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
> index d7fe023b3080..dfaad0a279ff 100644
> --- a/Documentation/dev-tools/checkpatch.rst
> +++ b/Documentation/dev-tools/checkpatch.rst
> @@ -465,13 +465,6 @@ Comments
>         * 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/
> -       */
> -
>      See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting
>  
>    **C99_COMMENTS**

-- 
~Randy

Re: [PATCH v2 1/2] docs: checkpatch: Align block comment style

[Joe Perches]

On Fri, 2025-10-17 at 13:37 -0700, Brian Norris wrote:
> Ironically, the block style comments in the checkpatch documentation are
> not aligned properly. Correct that.

<snort>  Thanks.

And for the deletion too.
I didn't know about that changed.

Re: [PATCH v2 1/2] docs: checkpatch: Align block comment style

[Jonathan Corbet]

Brian Norris <briannorris@chromium.org> writes:

> 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(-)

Both applied, thanks.

jon