DPDK patches and discussions
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>,
	Anatoly Burakov <anatoly.burakov@intel.com>
Subject: [dpdk-dev] [PATCH v5 01/18] doc/coding_style: add policy about master/slave
Date: Tue, 13 Oct 2020 08:25:53 -0700	[thread overview]
Message-ID: <20201013152610.2589-2-stephen@networkplumber.org> (raw)
In-Reply-To: <20201013152610.2589-1-stephen@networkplumber.org>

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 --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index d19b646fc6d7..5068ebb4f5f8 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 compatiablity
+with an existing (as of 2020) hardware or protocol
+specification that mandates those terms.
+
+
 Typedefs
 ~~~~~~~~
 
-- 
2.27.0


  reply	other threads:[~2020-10-13 15:26 UTC|newest]

Thread overview: 157+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-11 19:06 [dpdk-dev] [PATCH 00/15] Replace terms master/slave lcore with main/worker lcore Stephen Hemminger
2020-09-11 19:06 ` [dpdk-dev] [PATCH 01/15] eal: add macro to mark macros as deprecated Stephen Hemminger
2020-09-14  8:43   ` Bruce Richardson
2020-09-11 19:06 ` [dpdk-dev] [PATCH 02/15] eal: rename lcore word choices Stephen Hemminger
2020-09-14 14:40   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 03/15] rte_power: replace rte_master_lcore with rte_main_lcore Stephen Hemminger
2020-09-14 14:41   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 04/15] drivers: replace master lcore with main lcore Stephen Hemminger
2020-09-14 14:42   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 05/15] doc: " Stephen Hemminger
2020-09-14 14:56   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 06/15] app/test: replace uses of master/slave Stephen Hemminger
2020-09-14 15:02   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 07/15] app/test-pmd: replace master lcore with main lcore Stephen Hemminger
2020-09-14 15:04   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 08/15] app/test-eventdev: replace use of " Stephen Hemminger
2020-09-14 15:07   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 09/15] app: replace references to master/slave Stephen Hemminger
2020-09-14 15:10   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 10/15] examples: replace use of master with main Stephen Hemminger
2020-09-14 15:14   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 11/15] examples/multi_process: replace references to master/slave Stephen Hemminger
2020-09-14 15:16   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 12/15] examples/performance-thread: replace reference to master lcore Stephen Hemminger
2020-09-14 15:17   ` Burakov, Anatoly
2020-09-11 19:06 ` [dpdk-dev] [PATCH 13/15] examples/qos: replace references to master Stephen Hemminger
2020-09-14 15:18   ` Burakov, Anatoly
2020-09-11 19:07 ` [dpdk-dev] [PATCH 14/15] examples/ipsec-secgw: replace master lcore with main lcore Stephen Hemminger
2020-09-14 15:19   ` Burakov, Anatoly
2020-09-11 19:07 ` [dpdk-dev] [PATCH 15/15] examples: " Stephen Hemminger
2020-09-14 15:26   ` Burakov, Anatoly
2020-09-14 18:19 ` [dpdk-dev] [PATCH v2 00/17] Replace terms master/slave Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 01/17] doc/coding_style: add policy about master/slave Stephen Hemminger
2020-09-15  9:46     ` Burakov, Anatoly
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 02/17] eal: add macro to mark macros as deprecated Stephen Hemminger
2020-09-15  9:48     ` Burakov, Anatoly
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 03/17] eal: rename lcore word choices Stephen Hemminger
2020-09-15  9:57     ` Burakov, Anatoly
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 04/17] rte_power: replace rte_master_lcore with rte_main_lcore Stephen Hemminger
2020-09-15  9:57     ` Burakov, Anatoly
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 05/17] drivers: replace master lcore with main lcore Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 06/17] net/memif: replace master/slave arguments with server/client Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 07/17] doc: replace master lcore with main lcore Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 08/17] app/test: replace uses of master/slave Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 09/17] app/test-pmd: replace master lcore with main lcore Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 10/17] app/test-eventdev: replace use of " Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 11/17] app: replace references to master/slave Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 12/17] examples: replace use of master with main Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 13/17] examples/multi_process: replace references to master/slave Stephen Hemminger
2020-09-14 18:19   ` [dpdk-dev] [PATCH v2 14/17] examples/performance-thread: replace reference to master lcore Stephen Hemminger
2020-09-14 18:20   ` [dpdk-dev] [PATCH v2 15/17] examples/qos: replace references to master Stephen Hemminger
2020-09-14 18:20   ` [dpdk-dev] [PATCH v2 16/17] examples/ipsec-secgw: replace master lcore with main lcore Stephen Hemminger
2020-09-14 18:20   ` [dpdk-dev] [PATCH v2 17/17] examples: " Stephen Hemminger
2020-09-15 10:09   ` [dpdk-dev] [PATCH v2 00/17] Replace terms master/slave Burakov, Anatoly
2020-10-13 15:25   ` [dpdk-dev] [PATCH v5 00/18] " Stephen Hemminger
2020-10-13 15:25     ` Stephen Hemminger [this message]
2020-10-13 15:25     ` [dpdk-dev] [PATCH v5 02/18] eal: add macro to mark macros as deprecated Stephen Hemminger
2020-10-13 15:25     ` [dpdk-dev] [PATCH v5 03/18] eal: rename lcore word choices Stephen Hemminger
2020-10-13 15:25     ` [dpdk-dev] [PATCH v5 04/18] rte_power: replace rte_master_lcore with rte_main_lcore Stephen Hemminger
2020-10-13 15:25     ` [dpdk-dev] [PATCH v5 05/18] drivers: replace master lcore with main lcore Stephen Hemminger
2020-10-13 17:00       ` [dpdk-dev] [EXT] " Liron Himi
2020-10-13 15:25     ` [dpdk-dev] [PATCH v5 06/18] net/memif: replace master/slave arguments with server/client Stephen Hemminger
2020-10-13 15:25     ` [dpdk-dev] [PATCH v5 07/18] doc: replace master lcore with main lcore Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 08/18] app/test: replace uses of master/slave Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 09/18] app/test-pmd: replace master lcore with main lcore Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 10/18] app/test-eventdev: replace use of " Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 11/18] app: replace references to master/slave Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 12/18] examples: replace use of master with main Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 13/18] examples/multi_process: replace references to master/slave Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 14/18] examples/performance-thread: replace reference to master lcore Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 15/18] examples/qos: replace references to master Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 16/18] examples/ipsec-secgw: replace master lcore with main lcore Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 17/18] examples/pipeline: fix master/slave usage Stephen Hemminger
2020-10-13 15:26     ` [dpdk-dev] [PATCH v5 18/18] examples: replace master lcore with main lcore Stephen Hemminger
2020-09-15 15:10 ` [dpdk-dev] [PATCH v3 00/17] Replace terms master/slave Stephen Hemminger
2020-09-15 15:10   ` [dpdk-dev] [PATCH v3 01/17] doc/coding_style: add policy about master/slave Stephen Hemminger
2020-09-15 15:10   ` [dpdk-dev] [PATCH v3 02/17] eal: add macro to mark macros as deprecated Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 03/17] eal: rename lcore word choices Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 04/17] rte_power: replace rte_master_lcore with rte_main_lcore Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 05/17] drivers: replace master lcore with main lcore Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 06/17] net/memif: replace master/slave arguments with server/client Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 07/17] doc: replace master lcore with main lcore Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 08/17] app/test: replace uses of master/slave Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 09/17] app/test-pmd: replace master lcore with main lcore Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 10/17] app/test-eventdev: replace use of " Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 11/17] app: replace references to master/slave Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 12/17] examples: replace use of master with main Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 13/17] examples/multi_process: replace references to master/slave Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 14/17] examples/performance-thread: replace reference to master lcore Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 15/17] examples/qos: replace references to master Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 16/17] examples/ipsec-secgw: replace master lcore with main lcore Stephen Hemminger
2020-09-15 15:11   ` [dpdk-dev] [PATCH v3 17/17] examples: " Stephen Hemminger
2020-09-15 15:58   ` [dpdk-dev] [PATCH v3 00/17] Replace terms master/slave Stephen Hemminger
2020-09-16  9:31   ` Burakov, Anatoly
2020-10-09 21:38 ` [dpdk-dev] [PATCH v4 " Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 01/17] doc/coding_style: add policy about master/slave Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 02/17] eal: add macro to mark macros as deprecated Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 03/17] eal: rename lcore word choices Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 04/17] rte_power: replace rte_master_lcore with rte_main_lcore Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 05/17] drivers: replace master lcore with main lcore Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 06/17] net/memif: replace master/slave arguments with server/client Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 07/17] doc: replace master lcore with main lcore Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 08/17] app/test: replace uses of master/slave Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 09/17] app/test-pmd: replace master lcore with main lcore Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 10/17] app/test-eventdev: replace use of " Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 11/17] app: replace references to master/slave Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 12/17] examples: replace use of master with main Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 13/17] examples/multi_process: replace references to master/slave Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 14/17] examples/performance-thread: replace reference to master lcore Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 15/17] examples/qos: replace references to master Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 16/17] examples/ipsec-secgw: replace master lcore with main lcore Stephen Hemminger
2020-10-09 21:38   ` [dpdk-dev] [PATCH v4 17/17] examples: " Stephen Hemminger
2020-10-09 21:55   ` [dpdk-dev] [PATCH v4 00/17] Replace terms master/slave Stephen Hemminger
2020-10-13  9:31     ` David Marchand
2020-10-14 15:27 ` [dpdk-dev] [PATCH v6 00/18] " Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 01/18] doc/coding_style: add policy about master/slave Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 02/18] eal: add macro to mark macros as deprecated Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 03/18] eal: rename lcore word choices Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 04/18] rte_power: replace rte_master_lcore with rte_main_lcore Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 05/18] drivers: replace master lcore with main lcore Stephen Hemminger
2020-10-14 15:35     ` Ajit Khaparde
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 06/18] net/memif: replace master/slave arguments with server/client Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 07/18] doc: replace master lcore with main lcore Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 08/18] app/test: replace uses of master/slave Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 09/18] app/test-pmd: replace master lcore with main lcore Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 10/18] app/test-eventdev: replace use of " Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 11/18] app: replace references to master/slave Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 12/18] examples: replace use of master with main Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 13/18] examples/multi_process: replace references to master/slave Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 14/18] examples/performance-thread: replace reference to master lcore Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 15/18] examples/qos: replace references to master Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 16/18] examples/ipsec-secgw: replace master lcore with main lcore Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 17/18] examples/pipeline: fix master/slave usage Stephen Hemminger
2020-10-14 15:27   ` [dpdk-dev] [PATCH v6 18/18] examples: replace master lcore with main lcore Stephen Hemminger
2020-10-15 22:57 ` [dpdk-dev] [PATCH v7 00/20] Replace terms master/slave Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 01/20] doc/coding_style: add policy about master/slave Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 02/20] eal: add macro to mark macros as deprecated Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 03/20] eal: rename lcore word choices Stephen Hemminger
2020-10-20 10:21     ` Thomas Monjalon
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 04/20] rte_power: replace rte_master_lcore with rte_main_lcore Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 05/20] drivers: replace master lcore with main lcore Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 06/20] net/memif: replace master/slave arguments with server/client Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 07/20] doc: replace master lcore with main lcore Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 08/20] app/test: replace uses of master/slave Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 09/20] app/test-pmd: replace master lcore with main lcore Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 10/20] app/test-eventdev: replace use of " Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 11/20] app: replace references to master/slave Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 12/20] examples: replace use of master with main Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 13/20] examples/multi_process: replace references to master/slave Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 14/20] examples/performance-thread: replace reference to master lcore Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 15/20] examples/qos: replace references to master Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 16/20] examples/ipsec-secgw: replace master lcore with main lcore Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 17/20] examples/pipeline: fix master/slave usage Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 18/20] examples: replace master lcore with main lcore Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 19/20] drivers/octeontx2: replace master/slave wording Stephen Hemminger
2020-10-15 22:57   ` [dpdk-dev] [PATCH v7 20/20] drivers/failsafe: replace references to slave devices Stephen Hemminger
2020-10-20 10:23   ` [dpdk-dev] [PATCH v7 00/20] Replace terms master/slave Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201013152610.2589-2-stephen@networkplumber.org \
    --to=stephen@networkplumber.org \
    --cc=anatoly.burakov@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).