Received-SPF: pass (google.com: domain of linux-kernel+bounces-181195-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Message-ID: <4a77b3a77db293acba504914af220d8b8d644616.camel@perches.com>
Subject: Re: [PATCH 1/1] checkpatch: allow multi-statement declarative
 macros.
From: Joe Perches <joe@perches.com>
To: Jim Cromie <jim.cromie@gmail.com>, linux-kernel@vger.kernel.org
Cc: akpm@linuxfoundation.org, Andy Whitcroft <apw@canonical.com>, Dwaipayan
 Ray <dwaipayanray1@gmail.com>, Lukas Bulwahn <lukas.bulwahn@gmail.com>
Date: Thu, 16 May 2024 07:43:18 -0700
In-Reply-To: <20240516141418.25345-1-jim.cromie@gmail.com>
References: <20240516141418.25345-1-jim.cromie@gmail.com>
Content-Type: text/plain; charset="ISO-8859-1"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.48.4 (3.48.4-1.fc38) 
Precedence: bulk
MIME-Version: 1.0

On Thu, 2024-05-16 at 08:14 -0600, Jim Cromie wrote:
> Declarative macros, which declare/define storage (at either file or
> function scope), cannot be wrapped in do-while statements.  So
> checkpatch advice is incorrect here.
>=20
> The code has an $exceptions regex which allows multiple statements
> based on the macro name, etc; /DECLARE_PER_CPU|DEFINE_PER_CPU/ are
> currently accepted, widen those to accept /DECLARE|DEFINE/.

It seems this exempts too large a number of these macros

$ git grep -P '^\s*\#\s*define\s+\w*(?:DECLARE|DEFINE)\w*'|wc -l
5075

How about somehow limiting these exemptions more strictly?

> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -5901,6 +5901,7 @@ sub process {
>  			}
>  		}
> =20
> +# except for declarative macros (whether file or function scope),
>  # multi-statement macros should be enclosed in a do while loop, grab the
>  # first statement and ensure its the whole macro if its not enclosed
>  # in a known good container
> @@ -5958,8 +5959,8 @@ sub process {
>  				$Declare|
>  				module_param_named|
>  				MODULE_PARM_DESC|
> -				DECLARE_PER_CPU|
> -				DEFINE_PER_CPU|
> +				DECLARE|
> +				DEFINE|
>  				__typeof__\(|
>  				union|
>  				struct|