linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] coding-style: Adds examples for alternatives to 'blacklist'
@ 2020-07-15 17:25 Paul Schulz
  0 siblings, 0 replies; only message in thread
From: Paul Schulz @ 2020-07-15 17:25 UTC (permalink / raw)
  To: linux-doc; +Cc: Paul Schulz, Jonathan Corbet

Replacing the term 'blacklist' with a term that better describes
a lists functionality or it's use makes its usage more understandable,
rather than a generic 'denylist' or 'blocklist'

eg. 'quirklist' for hardware cards what behave differently
    'invalidlist' for a list of invalid hardware strings

Signed-off-by: Paul Schulz <paul@mawsonlakes.org>
---
 Documentation/process/coding-style.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index 1bee6f8affdb..3e5ca93a4443 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -334,6 +334,10 @@ Recommended replacements for 'blacklist/whitelist' are:
     'denylist / allowlist'
     'blocklist / passlist'
 
+Specific reasons for a lists functionality should also be considered. eg
+    'quirklist'
+    'invalidlist'
+
 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
-- 
2.25.1


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2020-07-15 17:30 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-15 17:25 [PATCH] coding-style: Adds examples for alternatives to 'blacklist' Paul Schulz

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).