From: Stephen Hemminger Date: Thu, 15 Oct 2020 22:57:17 +0000 (-0700) Subject: doc: add policy about master/slave words X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=57c789fd94d97281a55b8fe741c33d278bd52e13;p=dpdk.git doc: add policy about master/slave words 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. Signed-off-by: Stephen Hemminger Acked-by: Anatoly Burakov --- diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst index d19b646fc6..dfc211f98d 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. +Naming +------ + +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 compatibility +with an existing (as of 2020) hardware or protocol +specification that mandates those terms. + + Typedefs ~~~~~~~~