linux-kernel - [PATCH v3] CodingStyle: Inclusive Terminology

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <159423201991.2466245.8461410729774664077.stgit@dwillia2-desk3.amr.corp.intel.com>
Date:   Wed, 08 Jul 2020 11:14:27 -0700
From:   Dan Williams <dan.j.williams@...el.com>
To:     corbet@....net
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Dave Airlie <airlied@...hat.com>,
        SeongJae Park <sjpark@...zon.de>,
        Christian Brauner <christian.brauner@...ntu.com>,
        James Bottomley <James.Bottomley@...senPartnership.com>,
        Mark Brown <broonie@...nel.org>, Theodore Ts'o <tytso@....edu>,
        Shuah Khan <skhan@...uxfoundation.org>,
        Dan Carpenter <dan.carpenter@...cle.com>,
        Kees Cook <keescook@...omium.org>,
        Olof Johansson <olof@...om.net>, Chris Mason <clm@...com>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        torvalds@...ux-foundation.org,
        tech-board-discuss@...ts.linuxfoundation.org,
        ksummit-discuss@...ts.linuxfoundation.org,
        linux-kernel@...r.kernel.org
Subject: [PATCH v3] CodingStyle: Inclusive Terminology

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 <rdunlap@...radead.org>
Acked-by: Dave Airlie <airlied@...hat.com>
Acked-by: SeongJae Park <sjpark@...zon.de>
Acked-by: Christian Brauner <christian.brauner@...ntu.com>
Acked-by: James Bottomley <James.Bottomley@...senPartnership.com>
Reviewed-by: Mark Brown <broonie@...nel.org>
Signed-off-by: Theodore Ts'o <tytso@....edu>
Signed-off-by: Shuah Khan <skhan@...uxfoundation.org>
Signed-off-by: Dan Carpenter <dan.carpenter@...cle.com>
Signed-off-by: Kees Cook <keescook@...omium.org>
Signed-off-by: Olof Johansson <olof@...om.net>
Signed-off-by: Jonathan Corbet <corbet@....net>
Signed-off-by: Chris Mason <clm@...com>
Signed-off-by: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Signed-off-by: Dan Williams <dan.j.williams@...el.com>
---
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
 -----------