From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
by inbox.dpdk.org (Postfix) with ESMTP id 45E68A04C7;
Mon, 14 Sep 2020 20:20:22 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
by dpdk.org (Postfix) with ESMTP id A8B7F1BFC5;
Mon, 14 Sep 2020 20:20:14 +0200 (CEST)
Received: from mail-pf1-f194.google.com (mail-pf1-f194.google.com
[209.85.210.194]) by dpdk.org (Postfix) with ESMTP id C4F4A160
for <dev@dpdk.org>; Mon, 14 Sep 2020 20:20:12 +0200 (CEST)
Received: by mail-pf1-f194.google.com with SMTP id k15so241016pfc.12
for <dev@dpdk.org>; Mon, 14 Sep 2020 11:20:12 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=networkplumber-org.20150623.gappssmtp.com; s=20150623;
h=from:to:cc:subject:date:message-id:in-reply-to:references
:mime-version:content-transfer-encoding;
bh=qdgWjAnlyDNZ46l+WpEk46XEj7TpmjGD2/97xGfxGDU=;
b=cqrkKAtKCKaNfpnFgo5dPO68EYN0F6m0JKyPMHP5Hsq2a6SxoWnu/umpM+EW3yx3mS
0VKeg8/c70J4GbDbxX/hjqUwLO81wExO3HK0p9qFWrEJniZnRQDzURZ1IwDAJRhM5RXZ
vDVichzMMXpu/5GOUPARzB55VASMD8gJsm80pcfRbuX/Sz+S4iJVMRkwTkqGI8+G2m2A
baeof3xC6MazpF/zCSbuj9KR6B1hfN9tycfdWhMSyx/IOMEFkJNQ4phimQpPlo9PbMnC
rPC4ufO6uVo+61iE+GpHqKyNNjibfmc1CRoAucLhtpcSS6ZscxFN5PPI7wO1iZY6FkN7
TzVg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20161025;
h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
:references:mime-version:content-transfer-encoding;
bh=qdgWjAnlyDNZ46l+WpEk46XEj7TpmjGD2/97xGfxGDU=;
b=qWICnYpTKm8YuuInJ8jiz87IqyGSaGFHAdKNswNng4X72pPpl7KAYh1IkPONR3A2ip
i9nf6RJXI9vK1FjXzOx/0LDxhpZnenzWAHoOfKLr26x01aZdnarJcjZq8XmoyVq6chGf
030YgtjNsN0A7V4QA4ICTzb2VuSfSy3xCowJqJym1IePxxgdSVE61QQVtn7Pqd/VAQNr
iTmgJORO2DJkcKYRz0t+s1qbSOeSoHmWMSOmf2FZKS6sfEEd7QxYdMbt2iu7K/BTo478
Gp3z9m7rcPC8yQO7YglrKorutLWaMCB5fD3NWBCb6m16zksuUQBV/+2p5zepTSutaQmi
805A==
X-Gm-Message-State: AOAM530K2jj8J+P7sgT4wxje6368Nt/A6JILEVkZ+GL2S9yXfvqRsJzN
G6uK+6ZEuJeg0K4qlgZJcxFf8QNPsi63Bg==
X-Google-Smtp-Source: ABdhPJzkxdm5PgmMjSpLFgq/2Ut57/mJb06BjjLnLU3CgPpMe8FMSWfN6F2B26pGlX3yDmn3x6OURw==
X-Received: by 2002:a05:6a00:15c1:b029:13e:d13d:a04d with SMTP id
o1-20020a056a0015c1b029013ed13da04dmr13832857pfu.19.1600107611450;
Mon, 14 Sep 2020 11:20:11 -0700 (PDT)
Received: from hermes.lan (204-195-22-127.wavecable.com. [204.195.22.127])
by smtp.gmail.com with ESMTPSA id u6sm9952728pjy.37.2020.09.14.11.20.10
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Mon, 14 Sep 2020 11:20:10 -0700 (PDT)
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Date: Mon, 14 Sep 2020 11:19:46 -0700
Message-Id: <20200914182002.6750-2-stephen@networkplumber.org>
X-Mailer: git-send-email 2.27.0
In-Reply-To: <20200914182002.6750-1-stephen@networkplumber.org>
References: <20200911190701.29171-1-stephen@networkplumber.org>
<20200914182002.6750-1-stephen@networkplumber.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: [dpdk-dev] [PATCH v2 01/17] doc/coding_style: add policy about
master/slave
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.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.
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 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.
+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