From patchwork Thu Jun 4 21:02:00 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 70862 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id BF177A00C4; Thu, 4 Jun 2020 23:02:15 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 5AEE21D5E6; Thu, 4 Jun 2020 23:02:14 +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 76E011D5CF for ; Thu, 4 Jun 2020 23:02:12 +0200 (CEST) Received: by mail-pg1-f194.google.com with SMTP id r10so4049694pgv.8 for ; Thu, 04 Jun 2020 14:02:12 -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:mime-version :content-transfer-encoding; bh=OZR1YaXrb1u9bCeakG6ah5IBojzeuveJxU7XcHnw0gU=; b=fbe9mHQ+d9AtNtF2e1BLrERKpk0rfDhnMHwf5xDmOTuRHWa3t+bHLZPhWWss/7xBU6 HqTSrb2z0a8lhRXW2j6tdlI6a4j1sD0flSqx9pN+E1Ir41iI42W+1043aaZr03LsiP5h TExZfoZ8whyFCipdTXnucQDGmYHi3vxnC7Yb0YHQ3xUkdpr6gClTdnHVswnktHg3G1YJ CFlCiZ0tdvZFV9zasbWr3mpZ+EWyRq9dRBNxRvmIsBh2BKU7wwMj+ogmN26TGa8sRhEw M+GpxtXt7l53423XVbAi6q4ADySwlgpGc3DKIBje6iN1FkmCF2av+SF6zR2WPfCDNaSg wuLw== 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:mime-version :content-transfer-encoding; bh=OZR1YaXrb1u9bCeakG6ah5IBojzeuveJxU7XcHnw0gU=; b=bjt9FECW+A0vL/t++tQBRcec9uCn+1xcefkhzTqFH2KAIwxsN6Eb/N5JnA6UVXiHvy UvlN99Dg6e3/jcTLDrc5t71TzKragy0I4O0yrRip+InZJWZZwRRh6juzF1OX6WSS6aqq IJISkmzbImhHeWu/0y15UTou9J+9A3xxJJ/pwuBKdlWNeL8+H/XUGykhKugPY76dQ7mE pioPW2BUIzOCBuZFUdjBcWJN8V92R+eQl9SwuhfjJFXnAtoE7O+fjVpxlCDloDmn7C3Q 02wRtFdryqwg6to+w+CW11m/etjh5tBpdke2etE+Ad93iTXV9Zz6NFJ1w5bnHGsobmek n85w== X-Gm-Message-State: AOAM533n3sAWMfrBIbuuG/vzgrQ4IoJhUrSygXo7mvEW4URSYHq9qBmJ yguUl3v5DVMwBYwVJMhGLayGmWxLABE= X-Google-Smtp-Source: ABdhPJwQQaKCnGKj8UKczOdDzMf2wqLnp06g0KTKsHaM258VF7FkttoSB6fIdHOtGUPDNP7obsm+Uw== X-Received: by 2002:a65:614b:: with SMTP id o11mr6145293pgv.443.1591304530954; Thu, 04 Jun 2020 14:02:10 -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 e12sm4872106pgi.40.2020.06.04.14.02.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Jun 2020 14:02:09 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Date: Thu, 4 Jun 2020 14:02:00 -0700 Message-Id: <20200604210200.25405-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Subject: [dpdk-dev] [RFC] doc: change to diverse and inclusive language 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" For diversity reasons, the DPDK should take every effort to eliminate master and slave terminology. The actual code change is just syntax, but it has bigger impacts. Lets announce this now and do it in the next API changing release. Acked-by: Luca Boccassi Acked-by: Bruce Richardson Acked-by: Aaron Conole --- doc/guides/rel_notes/deprecation.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 0bee924255af..6b5cbf8d0b0c 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -138,3 +138,30 @@ Deprecation Notices driver probe scheme. The legacy virtio support will be available through the existing VFIO/UIO based kernel driver scheme. More details at https://patches.dpdk.org/patch/69351/ + +* eal: To be more inclusive in choice of naming, the DPDK project + will follow established diversity guidelines. + The code base will be changed to replace references to sexist + and offensive terms used in function, documentation and variable + names. This change will be progressive across several releases. + + The immediate impact to the API/ABI is that references to + master and slave related to DPDK lcore will be changed to + primary and secondary. + + For example: ``rte_get_master_lcore()`` will be renamed + to ``rte_get_primary_lcore()``. For the 20.11, release + both names will be present and the old function will be + marked with the deprecated tag. + + The macros related to primary and secondary lcore will also + be change: ``RTE_LCORE_FOREACH_SLAVE`` will be replaced + with ``RTE_LCORE_FOREACH_SECONDARY``. + + Drivers and source not governed by API/ABI policy will change + as soon as practical. + + This change aligns DPDK with the MIT diversity guidelines: + https://www.cs.cmu.edu/~mjw/Language/NonSexist/vuw.non-sexist-language-guidelines.txt + and follows precedent of other open source projects: Django, Gnome, + ISC, Python, Rust