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 <[email protected]> Acked-by: Dave Airlie <[email protected]> Acked-by: SeongJae Park <[email protected]> Acked-by: Christian Brauner <[email protected]> Acked-by: James Bottomley <[email protected]> Reviewed-by: Mark Brown <[email protected]> Signed-off-by: Theodore Ts'o <[email protected]> Signed-off-by: Shuah Khan <[email protected]> Signed-off-by: Dan Carpenter <[email protected]> Signed-off-by: Kees Cook <[email protected]> Signed-off-by: Olof Johansson <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Signed-off-by: Chris Mason <[email protected]> Signed-off-by: Greg Kroah-Hartman <[email protected]> Signed-off-by: Dan Williams <[email protected]> --- 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 -----------
