On 10/17/25 11:02 AM, Brian Norris wrote:
> Ironically, the block style comments in the checkpatch documentation are
> not aligned properly. Correct that.
>
> Signed-off-by: Brian Norris <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Tested-by: Randy Dunlap <[email protected]>
However, I would just remove the entire second comment block and
its lead-in comment.
Networking no longer has its own comment style and it looks like
checkpatch no longer checks for that.
> ---
>
> 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
>
--
~Randy
