From:   "Wang, Wei W" <wei.w.wang@intel.com>
To:     Jonathan Corbet <corbet@lwn.net>, "arnd@arndb.de" <arnd@arndb.de>,
        "akpm@linux-foundation.org" <akpm@linux-foundation.org>,
        "keescook@chromium.org" <keescook@chromium.org>,
        "herbert@gondor.apana.org.au" <herbert@gondor.apana.org.au>,
        "josh@joshtriplett.org" <josh@joshtriplett.org>,
        "Nikula, Jani" <jani.nikula@intel.com>,
        "jgg@mellanox.com" <jgg@mellanox.com>,
        "dmatlack@google.com" <dmatlack@google.com>,
        "mizhang@google.com" <mizhang@google.com>,
        "pbonzini@redhat.com" <pbonzini@redhat.com>,
        "Christopherson,, Sean" <seanjc@google.com>
CC:     "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: RE: [PATCH v1 2/3] Documentation/CodingStyle: do not use data type
 names as variable names
Thread-Topic: [PATCH v1 2/3] Documentation/CodingStyle: do not use data type
 names as variable names
Thread-Index: AQHZTlCTsdfgmYhoBEqWM7ucxSddLq7qt9gAgAJWq/A=
Date:   Mon, 6 Mar 2023 11:03:20 +0000
Message-ID: <DS0PR11MB6373E6DC5F6FF3EB4824668ADCB69@DS0PR11MB6373.namprd11.prod.outlook.com>
References: <20230304041932.847133-1-wei.w.wang@intel.com>
 <20230304041932.847133-3-wei.w.wang@intel.com> <87mt4szhk5.fsf@meer.lwn.net>
In-Reply-To: <87mt4szhk5.fsf@meer.lwn.net>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?Au/N4kc5LjfrOdP+TkIJJvPTeZ4ebyn3bihCOZM3U/neetzgleNg3TtOlvqI?=
 =?us-ascii?Q?5p41GdIVnN8EvwrDYzcEqa69cVjs1LcmqaK8CZOdFFzs7ag6bEDaDdCzOToS?=
 =?us-ascii?Q?7iUlEyMgArSJmXI1aDhMtzaP1oTjVgNnyyhE1uTSCqRF2/+UeJ3WZTtGeB/e?=
 =?us-ascii?Q?t8LXrjdRZxdNNImjfG/FJ04sc15YL2hlFSJXz1fHH9KG7l5EY1Zwit65UEAo?=
 =?us-ascii?Q?zYSscdlKwOyz83Dv2ZLqkyJOL2xH2RCHjTpuTugcWzt/KOxD/WuxfKTQwOAN?=
 =?us-ascii?Q?DqcROyBzeAhDRImB8c1ENwvuuN5OHNmdxv+Iy/Ul2U3a8UiETOVlYUHpDewE?=
 =?us-ascii?Q?mSo/9uxP6uFcjBYPb42goBbNnXaHKYCyIB1fNJB37VZ+e2EiqIcXb+OYbAqV?=
 =?us-ascii?Q?rZ6+4Xn+47DzOpdCKm/9QIm9OPzYpH/l36a3cQbEwXNCPiqFNYxfH9k0LRTF?=
 =?us-ascii?Q?ILhisaL5RpnY18E+qyvasMI7NXVjTYmQSdVNWdRqHkB0r6E9Ht1LZMPX8UWa?=
 =?us-ascii?Q?vrECdeP1GtcBkZKS6T+Xo38UhoSSLb/coNtGCuJ6aF4roLbrrqGCZs+wcU5R?=
 =?us-ascii?Q?p6bXokfmtAjXT8SE5PuKJUNLHIotfgf/vwmGAucIQWWjCF5rJ1kZaKOKQut4?=
 =?us-ascii?Q?5dudAFVO6inx2s4kfQTKg2TgyDNoFRgMNMcd4U66HgQ/9T6cSWOnfWXpimEX?=
 =?us-ascii?Q?WsOaZTIKlRempn0KD5OWhwZ+nsEmE56b37BdbDf+LFgT6c1ctoyGxuc+YePo?=
 =?us-ascii?Q?oGiZbjTReFIyktLifkj5axj53wd2PlGm9n2UUN414CJTlIXquyqr83EA9HB0?=
 =?us-ascii?Q?JZiCKlBpeVrbuDJG0u5s8fOucjP+Hh1y+nW2Pvybx/QOtX9K4WzG1BUGgjoj?=
 =?us-ascii?Q?vjjNsQQotCcloohxmglZWYtm+zB9srG3DFPUPQK91m8i52uv+NMWmMcf1DUh?=
 =?us-ascii?Q?xbxYoS05+tBOmMzGiOv9dD6UXc4f9MYx3uB/qdeBgOF6rbB5MID8SjEy3ZIQ?=
 =?us-ascii?Q?dvIwBjxxLdGewNxndtV9hHfn43zQk+5okm2CJA+C7k+GLkH6MedgpGbkTAaz?=
 =?us-ascii?Q?pRhCGwOtwh2WCqOhwFGeNWtGn60+77XbmBve4mUTF2ra43rmwt8ld37DHhus?=
 =?us-ascii?Q?AJRpmIyjrW1gGQWnjjSt91BUE3Dw+AGiduaqrFFhJrgZbP2y4V8VmtD7Vt+U?=
 =?us-ascii?Q?0O9gTc6uH/7Uxjga6+A+AVNKs79ePzpD+mR6H8IBnP2qR44B9CY7DxjuGNlI?=
 =?us-ascii?Q?DrqLQsFjU7Zfghlm/y5UEYvHXOJqMj+vTwdVF7FB3EpwG47nF1MBtYDFt7dB?=
 =?us-ascii?Q?e/Mn5KrUy3RzAYe7NAItEhmXKpU1his1LVhJzuobmNvmxYHlxK0cwIXVTSEv?=
 =?us-ascii?Q?sgaiMwHGmwwAzKlqiDzqaMWJI1p68mjc9fG0UMS9aNPl78lpb8hL+An59thI?=
 =?us-ascii?Q?hP6S9vt28h4tRR73R6tysIUYH+/fao+jLAg4alo+JsFVkPfmTU+hIi3YKHrT?=
 =?us-ascii?Q?yT8kz+1upxzAp4YiOdg+q+FQOOXJTS4uSvLhnv6i4uBFuZTuu8+f2TtfBrDV?=
 =?us-ascii?Q?molPDTNXAdeqNp1YM0l08v8Dp/EiqLq/CppdH9ts?=
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB6373.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: dd5cc1d5-e507-495b-e18a-08db1e32657b
X-MS-Exchange-CrossTenant-originalarrivaltime: 06 Mar 2023 11:03:20.2560
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: npKRRrsjYk8XfKi6hVyPXnHAsh77k7PCEqtZ8FOLHilS3zdZqLCKV1XGtt6bT3pPL3fIUmZcYeiR62H5jBEgZw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA1PR11MB7700
X-OriginatorOrg: intel.com
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Saturday, March 4, 2023 11:02 PM, Jonathan Corbet wrote:
> Wei Wang <wei.w.wang@intel.com> writes:
>=20
> > Observed some merged code uses "bool" as variable name. This is
> > confusion either for the reader or compilier. Add a rule to have
> > programmers avoid using data types as variable names.
> >
> > Signed-off-by: Wei Wang <wei.w.wang@intel.com>
> > ---
> >  Documentation/process/coding-style.rst | 3 +++
> >  1 file changed, 3 insertions(+)
> >
> > diff --git a/Documentation/process/coding-style.rst
> > b/Documentation/process/coding-style.rst
> > index 007e49ef6cec..6d7f4069d55d 100644
> > --- a/Documentation/process/coding-style.rst
> > +++ b/Documentation/process/coding-style.rst
> > @@ -356,6 +356,9 @@ specification that mandates those terms. For new
> > specifications  translate specification usage of the terminology to
> > the kernel coding  standard where possible.
> >
> > +"bool", "int", "long" etc. are specific names for data types, C
> > +programmers should not use them as variable names.
>=20
> It seems you found one place where bool was being misused.  Fixing it was
> certainly the right thing to do, but I'm not convinced we need to add clu=
tter
> to the documentation for this.

OK. I thought people would not name it in this way. But it indeed happened,
and I don't find we have such rules officially documented anywhere.
Fine if you (or most people) think that's not necessary, though.