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 <stephen@networkplumber.org> Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
This commit is contained in:
parent
1dd6cffb65
commit
57c789fd94
@ -283,6 +283,29 @@ Thus, the previous example would be better written:
|
|||||||
DPDK also provides an optimized way to store elements in lockless rings.
|
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.
|
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
|
Typedefs
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user