diff mbox series

[v3,01/17] doc/coding_style: add policy about master/slave

Message ID 20200915151114.12024-2-stephen@networkplumber.org (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series Replace terms master/slave | expand


Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Stephen Hemminger Sept. 15, 2020, 3:10 p.m. UTC
Update the coding style document to include a policy against
introducing new master/slave usage. This is taken from the similar
place in the Linux kernel coding style.

Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
 doc/guides/contributing/coding_style.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
diff mbox series


diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index 0be9546a6aa8..2c915fa38240 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -283,6 +283,29 @@  Thus, the previous example would be better written:
 DPDK also provides an optimized way to store elements in lockless rings.
 This should be used in all data-path code, when there are several consumer and/or producers to avoid locking for concurrent access.
+For symbol names and documentation, new usage of
+'master / slave' (or 'slave' independent of 'master') and 'blacklist /
+whitelist' is not allowed.
+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 compatiablity
+with an existing (as of 2020) hardware or protocol
+specification that mandates those terms.