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 3338DA04DB; Fri, 16 Oct 2020 00:58:14 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 85D161E495; Fri, 16 Oct 2020 00:57:52 +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 7C5851DEB9 for ; Fri, 16 Oct 2020 00:57:48 +0200 (CEST) Received: by mail-pf1-f194.google.com with SMTP id e10so340145pfj.1 for ; Thu, 15 Oct 2020 15:57:48 -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=bENAZ7XW3AWNktClHBIMVXm30fUfQJ4JLKRWIPrHfI0=; b=e9Grk7Ivz78n13AMx+u4bd7xjBbBuVJNQgk5CXL427hQi9WvRhu4yRPxL6q6qSNPmi c06Sz0Hx9C1yHmCD8RJaYVEDNj/Rl12Us3mYG2wQgfEReh4ua+Ow2+czOrF/Zjox3p2Z Al3I/6FpV9pLcaPoiWDsmXdqJMSbyIxUcnVhFEZ9lSRKxopL/+oypBJi5sums1m9fWxJ S7G8OZr5nKwtBR5I3MzQqlPHYsRmIueCvesnUOwmQGDRaKN6k6qf/IMM1DIB3kBrRfMk FjYW8/S0XCeBRtj5KMPtm/YQ46sy59dDlCkDbPvPLxXUYySgq0JXa6YT6yc225y7XFlh HZpA== 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=bENAZ7XW3AWNktClHBIMVXm30fUfQJ4JLKRWIPrHfI0=; b=CnXkBQEPobc6OeXvaG4ngLG+kHq5xEw0XCRSBAJXvgZ01fwgN4gKgtoNfONcr71acc SKm7ceRRDkkVf96nQCyohI4UQ/bM4EgIMy+H7cqtyIgpTgW4i3PICuRtaIEsgIPiDDpC evRe4AP3v7HT6MbCPtBQJCDMYIm+jmp+1vdZRUdK5D7GGk4RY7MDjirMalHDr3OFTymn XccxHn+Fw2L7+D6GGA0KMhfJCHKP/W4Ec2lKUwwJSyj1DbynWTD+Qoo7XTHqgU2pEHjA Uk4bzxx4tZWWd0O60t2OsUuvVIU9dK2ehSmrgfNFzGYiYyIX10yLXdWDpI+lr44Kqlhd skOQ== X-Gm-Message-State: AOAM530FTOghs/EcwS/bzimnF2rNy9c+K6Hv/uVxK7rJrgdAACBm6ccK fz4h76VCf36Buta/Xo4SpoAngEo1gA/3rg== X-Google-Smtp-Source: ABdhPJxrFRSUhQ/B6LOgTLF33tF5IMsGmzDXGX1/+vHs8w/ISWStgE9SYQ5K5J85zrBq1I5m664/6A== X-Received: by 2002:a63:5245:: with SMTP id s5mr642599pgl.205.1602802666151; Thu, 15 Oct 2020 15:57:46 -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 x4sm324055pfm.86.2020.10.15.15.57.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 15 Oct 2020 15:57:45 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Anatoly Burakov Date: Thu, 15 Oct 2020 15:57:17 -0700 Message-Id: <20201015225736.12167-2-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201015225736.12167-1-stephen@networkplumber.org> References: <20200911190701.29171-1-stephen@networkplumber.org> <20201015225736.12167-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v7 01/20] 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..dfc211f98d3f 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 compatibility +with an existing (as of 2020) hardware or protocol +specification that mandates those terms. + + Typedefs ~~~~~~~~ -- 2.27.0