From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id C43C0A04B7; Tue, 13 Oct 2020 17:26:52 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E7FF51DCFD; Tue, 13 Oct 2020 17:26:28 +0200 (CEST) Received: from mail-pl1-f196.google.com (mail-pl1-f196.google.com [209.85.214.196]) by dpdk.org (Postfix) with ESMTP id 248721DCFC for ; Tue, 13 Oct 2020 17:26:27 +0200 (CEST) Received: by mail-pl1-f196.google.com with SMTP id p11so1233pld.5 for ; Tue, 13 Oct 2020 08:26:27 -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=l5y5oQ90YRuAubHMODThtV24FyKev0TejUHsmEo6Dak=; b=OYME3I/DOYm3hbE/+AOprMeeU966Wb7oJJorUnKmXZFjKBXOPgEUCknzfn2RvHUYGl 6CiIRbQhcb0AkbaTcaHHeffi0nU14TFmZqLpytWH3fgi/xTOGgzVJfztwyc27iRBXufp m1n3Xh4lmwB9C9ewa6wzk8Mm89yGWEbyTkQ5uhTrNJfoMUYWifckAoHZccBZjAireIF8 KcXQnLfmkrgBmvHoLiPGhoH3H1Ws8hmnOoS03LWiWXO5rHNkCFDk+k+JosZu9jtiIeRL 9niUSHSFBVvHiM61VnV8dgcaig6Lef8pGiIwaN+8YjmgtNN1Ir/rj/b9NY8KrkGzvvhc U/pA== 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=l5y5oQ90YRuAubHMODThtV24FyKev0TejUHsmEo6Dak=; b=aVqXW7Ar27YW5BrIEVTxZT8kYPXRSUGv5XNaAmHPwdD/6uVl7TKb8y+w2EUbFOuPGO Xb3z6js/IJrjNvm3PgxRBp0UcXCICjcCDh2Tb7DgR2aWiBKjyERGlGK9JTDC3PMXO+hx ECWRysis2sq0vcJeBSLi92+JKoOuIUYP94doL2J9ls/sauQdLZV26Tij/SnOlW11vmes rQrrK7vhikye8F0AT0jDFDALXWuKob3PDsJ2fS/FlFcdIa7K0TnchF4KCavKah+SJiba 64jMt2Ikxy+ShH7Z4jtghkioXAGBPYsbqwCfh3Uj5FNAIao2iO++9vS+bMYyFAeszVJT MsUA== X-Gm-Message-State: AOAM531GbzP6eHvjHwW5u2kCuj6IzeRFJ1fMnHZjpz0/8RimBSJFIrbq 5oqC+Jgz+aPwMj2Ol8G63gxL83GdcsMGMQ== X-Google-Smtp-Source: ABdhPJw1vsh/IKdnLn2wmdh8qw4doX8UA6kRfdRgZTLts+sUYJrUHXx4oUK9nL9Zpj9ctwtkLBmBuA== X-Received: by 2002:a17:90a:a394:: with SMTP id x20mr216571pjp.213.1602602785163; Tue, 13 Oct 2020 08:26:25 -0700 (PDT) Received: from hermes.local (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id z12sm23815233pfr.197.2020.10.13.08.26.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 13 Oct 2020 08:26:20 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Anatoly Burakov Date: Tue, 13 Oct 2020 08:25:53 -0700 Message-Id: <20201013152610.2589-2-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201013152610.2589-1-stephen@networkplumber.org> References: <20200914182002.6750-1-stephen@networkplumber.org> <20201013152610.2589-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v5 01/18] 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 Signed-off-by: Stephen Hemminger --- 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