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 61D9DA04BC; Fri, 9 Oct 2020 23:39:28 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 64D101D565; Fri, 9 Oct 2020 23:39:08 +0200 (CEST) Received: from mail-pg1-f194.google.com (mail-pg1-f194.google.com [209.85.215.194]) by dpdk.org (Postfix) with ESMTP id 6D7581D545 for ; Fri, 9 Oct 2020 23:39:06 +0200 (CEST) Received: by mail-pg1-f194.google.com with SMTP id y14so8254559pgf.12 for ; Fri, 09 Oct 2020 14:39:06 -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=QKILIlgZl8UTstIi8lTYgGXOYQuOzR8B63f97s+A865u4DLhmTaKTplIcrjDnzHtF0 aOgDNtNZaREaWyqUdTATzKt1GbVtcWoBJ4LhTmWC2dafWT4vrzvAU78FeYR8Ubsz4DPt TxsCe7oOzhG0vj9hKZueO2BaZAXusKaMFsTkg8wRXDeP4Axri3ycOie5ctTlBFShe1+w CLmDq1wX9pkQS581hRXcsnmz6Q9lcNr5z61m19NZ/up9lWZ5MnaBrqWdYt7SX54vMQpY bcfrmdHKy3dZMDNEnudKgHmCOY7iP97Cz1vdHEuaZxNCdWu16S51J0u92pKh0vVcpqk+ ryFw== 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=fiCQ+NKTW3aMrdsEFRs1NE5TLSqn8lFsmlOS2YbdkZduQqjgb8UFjsfpWEvpkR7xQx E+nGVnz1TjvPRJc3twWDxlcN3GQNfOhZgE9DOyHnrXO1YUXTG99XMnVArwJSqlsGQqrQ ne64sfP/H0UdsOqNz+HQ8r5d2HdiJ0BdvhqoisLI/IjO0CJ8hGeQ+p1OqwhsIn+lIjAD Sw9S1QskYGgCnFgR+zsXtIkSgtnPbEsL5IAQJB/vHk7mm2m3n/uYyH2WScqnClG2FnOb vWtG25DYKjKCN8upDe5UMC2TnAzNyMBDFdCpjDeFqY3FiVW9PLVY8htEWNeErk0eX7Fr PLRA== X-Gm-Message-State: AOAM532bPDt04RjvxLL8MVAFBqAOOP2OOfBQ1Ap5nXLTxghP+Bv6inzK wK9l7uXasv/DfbbtTzFzlA0HizEMIXtHxw== X-Google-Smtp-Source: ABdhPJxrllBzDrY0AOlO12sJ85mOPwmqOKH/N88/ZoUVxJD/WFZf0VhmWP1pHzU+YK+jbUnHJbUZAA== X-Received: by 2002:a17:90a:b293:: with SMTP id c19mr6843535pjr.122.1602279544363; Fri, 09 Oct 2020 14:39:04 -0700 (PDT) Received: from hermes.corp.microsoft.com (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id x18sm12173381pfj.90.2020.10.09.14.39.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 09 Oct 2020 14:39:03 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Anatoly Burakov Date: Fri, 9 Oct 2020 14:38:39 -0700 Message-Id: <20201009213855.17933-2-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201009213855.17933-1-stephen@networkplumber.org> References: <20200911190701.29171-1-stephen@networkplumber.org> <20201009213855.17933-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v4 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 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