Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:5 as permitted sender) client-ip=2620:137:e000::3:5;
Date:   Tue, 26 Sep 2023 21:22:52 +0200
From:   Petr =?UTF-8?B?VGVzYcWZw61r?= <petr@tesarici.cz>
To:     Andy Whitcroft <apw@canonical.com>, Joe Perches <joe@perches.com>,
        Dwaipayan Ray <dwaipayanray1@gmail.com>,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>,
        linux-kernel@vger.kernel.org (open list)
Cc:     Catalin Marinas <catalin.marinas@arm.com>
Subject: Re: [PATCH] checkpatch: warn about multi-line comments without an
 empty /* line
Message-ID: <20230926212252.3e44bd22@meshulam.tesarici.cz>
In-Reply-To: <20230926192006.18351-1-petr@tesarici.cz>
References: <20230926192006.18351-1-petr@tesarici.cz>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

V Tue, 26 Sep 2023 21:20:06 +0200
Petr Tesarik <petr@tesarici.cz> naps=C3=A1no:

> According to Documentation/process/coding-style.rst, the preferred style
> for multi-line comments outside net/ and drivers/net/ is:
>=20
> .. code-block:: c
>=20
>         /*
>          * This is the preferred style for multi-line
>          * comments in the Linux kernel source code.
>          * Please use it consistently.
>          *
>          * Description:  A column of asterisks on the left side,
>          * with beginning and ending almost-blank lines.
>          */
>=20
> Signed-off-by: Petr Tesarik <petr@tesarici.cz>
> ---
>  scripts/checkpatch.pl | 8 ++++++++
>  1 file changed, 8 insertions(+)
>=20
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 7d16f863edf1..0fc3427a9ec9 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -4006,6 +4006,14 @@ sub process {
>  			     "networking block comments don't use an empty /* line, use /* Co=
mment...\n" . $hereprev);
>  		}
> =20
> +# Non-networking without an initial /*
> +		if ($realfile !~ m@^(drivers/net/|net/)@ &&
> +		    $prevrawline =3D~ /^\+[ \t]*\/\*.*[^ \t]$/ &&
> +		    $rawline =3D~ /^\+[ \t]*\*/) {
> +			WARN("MULTILINE_BLOCK_COMMENT_STYLE",

Oops. This should be just BLOCK_COMMENT_STYLE, without MULTILINE; v2 is
on the way...

Petr T

> +			     "multi-line block comments should start with an empty /* line\n"=
 . $hereprev);
> +		}
> +
>  # Block comments use * on subsequent lines
>  		if ($prevline =3D~ /$;[ \t]*$/ &&			#ends in comment
>  		    $prevrawline =3D~ /^\+.*?\/\*/ &&		#starting /*