Commit a5f526ec authored Jul 03, 2020 by Dan Williams

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@infradead.org>
Acked-by: Dave Airlie <airlied@redhat.com>
Acked-by: SeongJae Park <sjpark@amazon.de>
Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
Acked-by: James Bottomley <James.Bottomley@HansenPartnership.com>
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Acked-by: Andy Lutomirski <luto@kernel.org>
Acked-by: Laura Abbott <laura@labbott.name>
Acked-by: Gustavo A. R. Silva <gustavoars@kernel.org>
Reviewed-by: Matthias Brugger <matthias.bgg@gmail.com>
Reviewed-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
Signed-off-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Olof Johansson <olof@lixom.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Chris Mason <clm@fb.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Dan Williams <dan.j.williams@intel.com>

parent 9ebcfadb

Documentation/process/coding-style.rst

+20 −0

Original line number	Diff line number	Diff line
		@@ -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
		-----------

Admin message