Received-SPF: pass (google.com: domain of linux-kernel+bounces-108412-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Date: Wed, 20 Mar 2024 14:45:30 +1100
From: Stephen Rothwell <sfr@canb.auug.org.au>
To: Barry Song <21cnbao@gmail.com>
Cc: corbet@lwn.net, workflows@vger.kernel.org, linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org, Barry Song <v-songbaohua@oppo.com>, Andrew
 Morton <akpm@linux-foundation.org>, Chris Zankel <chris@zankel.net>, Huacai
 Chen <chenhuacai@loongson.cn>, Herbert Xu <herbert@gondor.apana.org.au>,
 Guenter Roeck <linux@roeck-us.net>, Max Filippov <jcmvbkbc@gmail.com>
Subject: Re: [PATCH] Documentation: coding-style: ask function-like macros
 to evaluate parameters
Message-ID: <20240320144530.4852845b@canb.auug.org.au>
In-Reply-To: <CAGsJ_4zpXwVEhsdffoZVBVWiwT4Lw2qEMrW-X92ib=kv=9Yx9g@mail.gmail.com>
References: <20240320001656.10075-1-21cnbao@gmail.com>
	<20240320124207.0c127947@canb.auug.org.au>
	<CAGsJ_4zpXwVEhsdffoZVBVWiwT4Lw2qEMrW-X92ib=kv=9Yx9g@mail.gmail.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="Sig_/TO1BZgkbiVYW.I8uMU2NSDG";
 protocol="application/pgp-signature"; micalg=pgp-sha256

--Sig_/TO1BZgkbiVYW.I8uMU2NSDG
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

Hi Barry,

On Wed, 20 Mar 2024 16:24:30 +1300 Barry Song <21cnbao@gmail.com> wrote:
>
> On Wed, Mar 20, 2024 at 2:42=E2=80=AFPM Stephen Rothwell <sfr@canb.auug.o=
rg.au> wrote:
> >
> > On Wed, 20 Mar 2024 13:16:56 +1300 Barry Song <21cnbao@gmail.com> wrote=
: =20
> > >
> > > diff --git a/Documentation/process/coding-style.rst b/Documentation/p=
rocess/coding-style.rst
> > > index 9c7cf7347394..8065747fddff 100644
> > > --- a/Documentation/process/coding-style.rst
> > > +++ b/Documentation/process/coding-style.rst
> > > @@ -827,6 +827,13 @@ Macros with multiple statements should be enclos=
ed in a do - while block:
> > >                               do_this(b, c);          \
> > >               } while (0)
> > >
> > > +Function-like macros should evaluate their parameters, for unused pa=
rameters,
> > > +cast them to void:
> > > +
> > > +.. code-block:: c
> > > +
> > > +     #define macrofun(a) do { (void) (a); } while (0)
> > > + =20
> >
> > Maybe add some comment about using a static inline function for these
> > simple versions instead, if at all possible, (it is suggested just
> > above this section) since that will still type check arguments. =20
>=20
> right, what about adding the below section together with the above (void)=
 cast?
>=20
> +Another approach could involve utilizing a static inline function to rep=
lace
> +the macro.:
> +
> +.. code-block:: c
> +
> +       static inline void fun(struct foo *foo)
> +       {
> +       }
> +

Looks good to me.

--=20
Cheers,
Stephen Rothwell

--Sig_/TO1BZgkbiVYW.I8uMU2NSDG
Content-Type: application/pgp-signature
Content-Description: OpenPGP digital signature

-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEENIC96giZ81tWdLgKAVBC80lX0GwFAmX6W9oACgkQAVBC80lX
0Gyhhgf9H0RNoO9xgy7+XrcwZ2zfiLubuD4oRaT2LODstAcOZQEKvdZgCun5V7SV
dNLWDGUkILR7hHHhPSkfFz7qmJXheUxXmkNvbyovSoVQpKCfIJtVwO9AKnwdcafL
LMBPvD4Fp/b00pLJ8rfETSorRwbE20gD5+NwesE6EtXPuwODDn4zKRwWLJHEl4Wa
PCZto1uEF+6oO50pfHDTjI/e0YM73MtNDY0H/FnevXBJqvotvRJn78k4lF9vCe5x
12t/CiOLK8igzbmRH76Em3soUscClwwnPm8U54BEm4hf3Yn72+rFpJRFKjwejFcW
ErErslr5cReDA7sSPZfE/cJOjqQcmQ==
=8E06
-----END PGP SIGNATURE-----

--Sig_/TO1BZgkbiVYW.I8uMU2NSDG--