On 08/07/2020 20:14, 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.st...@dwillia2-desk3.amr.corp.intel.com
Acked-by: Randy Dunlap <rdun...@infradead.org>
Acked-by: Dave Airlie <airl...@redhat.com>
Acked-by: SeongJae Park <sjp...@amazon.de>
Acked-by: Christian Brauner <christian.brau...@ubuntu.com>
Acked-by: James Bottomley <james.bottom...@hansenpartnership.com>
Reviewed-by: Mark Brown <broo...@kernel.org>
Signed-off-by: Theodore Ts'o <ty...@mit.edu>
Signed-off-by: Shuah Khan <sk...@linuxfoundation.org>
Signed-off-by: Dan Carpenter <dan.carpen...@oracle.com>
Signed-off-by: Kees Cook <keesc...@chromium.org>
Signed-off-by: Olof Johansson <o...@lixom.net>
Signed-off-by: Jonathan Corbet <cor...@lwn.net>
Signed-off-by: Chris Mason <c...@fb.com>
Signed-off-by: Greg Kroah-Hartman <gre...@linuxfoundation.org>
Signed-off-by: Dan Williams <dan.j.willi...@intel.com>
Reviewed-by: Matthias Brugger <matthias....@gmail.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.st...@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-disc...@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
