Return-Path: From: Jani Nikula In-Reply-To: <159423201991.2466245.8461410729774664077.stgit@dwillia2-desk3.amr.corp.intel.com> References: <159423201991.2466245.8461410729774664077.stgit@dwillia2-desk3.amr.corp.intel.com> Date: Wed, 15 Jul 2020 15:19:06 +0300 Message-ID: <87o8oh0y4l.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain Subject: Re: [Tech-board-discuss] [Ksummit-discuss] [PATCH v3] CodingStyle: Inclusive Terminology List-Id: Public TAB discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Dan Williams , corbet@lwn.net Cc: ksummit-discuss@lists.linuxfoundation.org, Greg Kroah-Hartman , SeongJae Park , linux-kernel@vger.kernel.org, tech-board-discuss@lists.linuxfoundation.org, James Bottomley , Dave Airlie , Christian Brauner , Dan Carpenter On Wed, 08 Jul 2020, Dan Williams wrote: > Linux maintains a coding-style and its own idiomatic set of terminology. > Update the style guidelines to recommend replacements for the terms > master/slave and blacklist/whitelist. > > Link: http://lore.kernel.org/r/159389297140.2210796.13590142254668787525.stgit@dwillia2-desk3.amr.corp.intel.com > Acked-by: Randy Dunlap > Acked-by: Dave Airlie > Acked-by: SeongJae Park > Acked-by: Christian Brauner > Acked-by: James Bottomley > Reviewed-by: Mark Brown > Signed-off-by: Theodore Ts'o > Signed-off-by: Shuah Khan > Signed-off-by: Dan Carpenter > Signed-off-by: Kees Cook > Signed-off-by: Olof Johansson > Signed-off-by: Jonathan Corbet > Signed-off-by: Chris Mason > Signed-off-by: Greg Kroah-Hartman > Signed-off-by: Dan Williams FWIW, Acked-by: Jani Nikula > --- > Changes since v2 [1]: > - Pick up missed sign-offs and acks from Jon, Shuah, and Christian > (sorry about missing those earlier). > > - Reformat the replacement list to make it easier to read. > > - Add 'controller' as a suggested replacement (Kees and Mark) > > - Fix up the paired term for 'performer' to be 'director' (Kees) > > - Collect some new acks, reviewed-by's, and sign-offs for v2. > > - Fix up Chris's email > > [1]: http://lore.kernel.org/r/159419296487.2464622.863943877093636532.stgit@dwillia2-desk3.amr.corp.intel.com > > > Documentation/process/coding-style.rst | 20 ++++++++++++++++++++ > 1 file changed, 20 insertions(+) > > diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst > index 2657a55c6f12..1bee6f8affdb 100644 > --- a/Documentation/process/coding-style.rst > +++ b/Documentation/process/coding-style.rst > @@ -319,6 +319,26 @@ If you are afraid to mix up your local variable names, you have another > problem, which is called the function-growth-hormone-imbalance syndrome. > See chapter 6 (Functions). > > +For symbol names and documentation, avoid introducing new usage of > +'master / slave' (or 'slave' independent of 'master') and 'blacklist / > +whitelist'. > + > +Recommended replacements for 'master / slave' are: > + '{primary,main} / {secondary,replica,subordinate}' > + '{initiator,requester} / {target,responder}' > + '{controller,host} / {device,worker,proxy}' > + 'leader / follower' > + 'director / performer' > + > +Recommended replacements for 'blacklist/whitelist' are: > + 'denylist / allowlist' > + 'blocklist / passlist' > + > +Exceptions for introducing new usage is to maintain a userspace ABI/API, > +or when updating code for an existing (as of 2020) hardware or protocol > +specification that mandates those terms. For new specifications > +translate specification usage of the terminology to the kernel coding > +standard where possible. > > 5) Typedefs > ----------- > > _______________________________________________ > Ksummit-discuss mailing list > Ksummit-discuss@lists.linuxfoundation.org > https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss -- Jani Nikula, Intel Open Source Graphics Center