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 A2423A04C7; Tue, 15 Sep 2020 17:21:46 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 6F49D1C1A4; Tue, 15 Sep 2020 17:20:12 +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 C86D01C120 for ; Tue, 15 Sep 2020 17:20:10 +0200 (CEST) Received: by mail-pg1-f194.google.com with SMTP id s65so2185068pgb.0 for ; Tue, 15 Sep 2020 08:20:10 -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=TNbH2X2gk6nrm8pb7XZJipFS/fneL8+qy63Oj0CB9b0=; b=Vdv5n1073YtPaleT/Zl8I0fhYypzG7fPJ9it/jGbx1dEhdg3gH063eiypDR6mq2Jx2 VfAMU2ik4iTQp5+3E67dQsSD/mbuTxDAwGwwQahvTXemHSAL6heA+dc5jVMMxfmyPAqV IXU2RzWFnxdLL6gWhzBVKDQfx/nUfqgf62WhmfqcDmsLXRpdIJX7FZeQzo1L+r3lgWw8 jdsZRenOwm6Wb5CUNMVTn9Pqj/6eIghZLH8a0+koKQNFn3C9Rm8OrTTiPqPJywYETUeK c19SXwC/L/XwZIbtkRLAE2xam7moielvlESqj/tcNSfF9kxklGRdlZTj6TVWOOdBOap7 kxOw== 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=TNbH2X2gk6nrm8pb7XZJipFS/fneL8+qy63Oj0CB9b0=; b=hNGYv9GFiZv4BVN0Io/0wjQFW5V2o+M+vPzwZAV05DC/sbELs6VfgSS87C5tfqP1I6 rHoKxKlq4yrVow+IZIMUEUIU+GHMDBorqe+akW2qDIp9vb8YdJTQNqGJboziedKzG9S6 9pYbrmLACWj+3uuzMlgxlUSl7jkC2MfmgDO0rVBUOVtsjj48q4Q4V+BJNn8Ayt1yJn9v Ojzj7T7KgcWTjjBvWf7uHwnavHmdIxvGm3+zBDo2BfWc8/s5S/Vhn2wNMhTqLwh5QmSV c7uUCd+q2ctOIsMvuF4yyAllFgQ2rlJGa9Bz9pbvOM7wZusS8+A7QpgJd/3R+uPJcCwF k/Vw== X-Gm-Message-State: AOAM530q88mo4bNhGOgrxPw4YkPRpvs6GFWB0pnQIfc4joulwkEevL/s eR3rDK1rRCOSGPJISn0Qar+jM9+zyEwOHA== X-Google-Smtp-Source: ABdhPJzRpidpO4mjoYb3MBSMqzeoxtBvMr3VOSSDnYLD50AeetfVRodVBms2Ij2Bvt9ERaZh+rNGXQ== X-Received: by 2002:a63:36cc:: with SMTP id d195mr15489838pga.426.1600182685159; Tue, 15 Sep 2020 08:11:25 -0700 (PDT) Received: from hermes.lan (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id c127sm13742278pfa.165.2020.09.15.08.11.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Sep 2020 08:11:24 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Anatoly Burakov Date: Tue, 15 Sep 2020 08:10:58 -0700 Message-Id: <20200915151114.12024-2-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20200915151114.12024-1-stephen@networkplumber.org> References: <20200911190701.29171-1-stephen@networkplumber.org> <20200915151114.12024-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v3 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 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