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 1C04BA04B7; Wed, 14 Oct 2020 17:28:26 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C00FC1DD0E; Wed, 14 Oct 2020 17:28:05 +0200 (CEST) Received: from mail-pg1-f195.google.com (mail-pg1-f195.google.com [209.85.215.195]) by dpdk.org (Postfix) with ESMTP id 1ACB41DBA2 for ; Wed, 14 Oct 2020 17:28:03 +0200 (CEST) Received: by mail-pg1-f195.google.com with SMTP id b23so1000655pgb.3 for ; Wed, 14 Oct 2020 08:28:02 -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=MG4pKxqk07fEeZlFOpY+IW11InV4uV0pTIG7KcnXHK8=; b=zvraVHsr/i0AiFh7cu1StBDEbB+4/oTy4yRYaI9mz944CIvJ+YR8gD3bs2ixr6SnUG Doqkk6WNmcTBIq9RpMWHB9FTwkDHU8lV4SdvjUdT09HkaWxJ+HydSAPDpTr0Syp4RFQV rNKRlzmjOruh8wgk6kOJPkTm5Dn0jSsvy6vrKi48u4O7eEEUFNUPUDYIQcX5rHb+Nylm dzWiiHZEbG7IssL2fDg/4poMJk3DQy34m31XLj5vhI9aJ/xpzuD7khsE0NYYUB9Fsd8R uCi6CnFGUZ/b4f9dV0DChdHUhg9xpPjBcAbErfN0cPHw62rrmQhUFMnw1AC14VhSrHHM uQmQ== 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=MG4pKxqk07fEeZlFOpY+IW11InV4uV0pTIG7KcnXHK8=; b=aBoeTPWtjAdCXLphWuOMYTbKPO1408jY8GXYXyPW+70i8CzQsYOVl2JWrN/Hm63N/y +HU34jIe6hjpnh4GryFLobRWXlaaiAQnrnr/C1EADopJg/gJ5DFcX6ZVJC7lTzjhdT9s xdojy22J0r29AULO5eB5OXxGC/GBqnl6BZn02x0GtTHvQ283AFKBWwJSrTXgBZqbRrT8 fstkBueKRcv7eAKWYNtrXGQ11t9Zv1uQiidIvVZcB5HNINKlmIJ85hIsx7RC3T3mc1ua S7qVpAWalXCybQNl6Jx8JIatHvsjBpp5Hn00BqlSUKK/NbghnM883D27E6CqHNoLfV6R 87Nw== X-Gm-Message-State: AOAM531JRS2PoNB/J9bMgl0EN6ZQMybsAo43ddtJFYwddoLonwSLRw/1 +3x4JlAoP8ZPEbj6yC/Gh0USVYkWfJZaTQ== X-Google-Smtp-Source: ABdhPJyvYhX1WIkrzp1ouve9Q4b4DEEdMkY1Vq9DAUm+7pBIbLuoTSTInR0B6E8F0c8ss2Uzk1T2aA== X-Received: by 2002:a63:e354:: with SMTP id o20mr4463130pgj.317.1602689280792; Wed, 14 Oct 2020 08:28:00 -0700 (PDT) Received: from hermes.local (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id j11sm3653457pfh.143.2020.10.14.08.27.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Oct 2020 08:27:59 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Anatoly Burakov Date: Wed, 14 Oct 2020 08:27:39 -0700 Message-Id: <20201014152756.6518-2-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201014152756.6518-1-stephen@networkplumber.org> References: <20200911190701.29171-1-stephen@networkplumber.org> <20201014152756.6518-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v6 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..5b4b71e2a416 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 compatability +with an existing (as of 2020) hardware or protocol +specification that mandates those terms. + + Typedefs ~~~~~~~~ -- 2.27.0