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 81B23A00C3; Sun, 7 Jun 2020 19:02:48 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 66B761BFC7; Sun, 7 Jun 2020 19:01:50 +0200 (CEST) Received: from mail-pf1-f182.google.com (mail-pf1-f182.google.com [209.85.210.182]) by dpdk.org (Postfix) with ESMTP id 086AA1BFB9 for ; Sun, 7 Jun 2020 19:01:48 +0200 (CEST) Received: by mail-pf1-f182.google.com with SMTP id j1so7282975pfe.4 for ; Sun, 07 Jun 2020 10:01:47 -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=ErvyGkxeKaSeAuVQgJj9B7qSte9RxjQDKGsr+5dZLYU=; b=UOpO8gOd7Ca1BwvlZchwofCne9KpmWxbwKVxmHCs077KHHcncVrrjePWAamUX0GdQh 6g7buT4PVBUXwdBH9JI3TsNAIAk3ALL5PodD7YsCVlEerWoK9hTHiWHe4aJzIvCm/k4J tkI9SX9nw/RPWNpZnH7+UmpivNfbMZaTrxYBv3qripk4xBiJt+Khs0qlZ2+S7PPlFMx0 PxhPVq50ZUtPztJTF+kSXUpd/NA7juIOmCnGrh39h95YI2wtq68bb2O0hZFxhK1Aqieh gIkzDcFWW3hs3SnMsaf4uJNY8Z4cBXBNWjnxoxbPVcKs11SRSUAPuWBkWBe+X5X9+N9R cEHA== 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=ErvyGkxeKaSeAuVQgJj9B7qSte9RxjQDKGsr+5dZLYU=; b=slNAzG7pexmA7wwidJfOi72AluSL9wid5OozH8C1shMW9ZkM3cR2lfCclOCp3J5a+p LDoAOQ5K2JPcO8QrMFC62+COm2X/xdyaNBRGZmRMV/E+rJu8IAniu4hL+fkWdT50dp9f yE0bvbkcd7Jqp0aVS1Ar2m8jnEIhPcdNOZ8SFHktHZ1AESjdDH4VR7w+PagEgEwWyGZ5 BKbXQf4d7n82Cki2ijax4PN6T3vKibsT+uZq4BJ7AYHuyX9xMX7fw8u2F7sBqnMxcAly 2Rj0ydrSqWMyCwx3uMGfjXahn7WB+WG35PP8QVhPWZ0A6M5teFvis2U8a5toejA+CM6H j+1g== X-Gm-Message-State: AOAM532ubibsUm/yqmNVA/Sq3iyVWMiDg43AwFbmuy7h48hlV5v0k/BS afyZpo1Nc+nqLkZAUEmTEWJypHEWEEY= X-Google-Smtp-Source: ABdhPJwcl5iV4vceallpotxcP7hDoUSlON+bNB3vLPVrOHnha35V0PvkA0s/mbztJLBxgl8RgsCKqg== X-Received: by 2002:a62:8487:: with SMTP id k129mr18484992pfd.296.1591549306068; Sun, 07 Jun 2020 10:01:46 -0700 (PDT) Received: from hermes.lan (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id y81sm4933458pfb.33.2020.06.07.10.01.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 07 Jun 2020 10:01:45 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Date: Sun, 7 Jun 2020 10:01:25 -0700 Message-Id: <20200607170127.15694-8-stephen@networkplumber.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: <20200607170127.15694-1-stephen@networkplumber.org> References: <20200607170127.15694-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH 7/9] doc: replace references to blacklist/whitelist 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" The terms blacklist and whitelist are no longer used. Replace them in the documentation. Most of this was automatic replacement, but in a couple of places the language was awkward before and have tried to improve the readabilty. Signed-off-by: Stephen Hemminger --- doc/guides/cryptodevs/dpaa2_sec.rst | 4 ++-- doc/guides/cryptodevs/dpaa_sec.rst | 4 ++-- doc/guides/cryptodevs/qat.rst | 4 ++-- doc/guides/freebsd_gsg/build_sample_apps.rst | 2 +- doc/guides/linux_gsg/build_sample_apps.rst | 2 +- doc/guides/linux_gsg/eal_args.include.rst | 14 +++++++------- doc/guides/nics/bnxt.rst | 6 +++--- doc/guides/nics/cxgbe.rst | 4 ++-- doc/guides/nics/dpaa.rst | 4 ++-- doc/guides/nics/dpaa2.rst | 4 ++-- doc/guides/nics/enic.rst | 6 +++--- doc/guides/nics/fail_safe.rst | 14 +++++++------- doc/guides/nics/features.rst | 2 +- doc/guides/nics/ice.rst | 2 +- doc/guides/nics/mlx4.rst | 6 +++--- doc/guides/nics/mlx5.rst | 2 +- doc/guides/nics/sfc_efx.rst | 2 +- doc/guides/nics/tap.rst | 2 +- doc/guides/prog_guide/env_abstraction_layer.rst | 7 +++---- doc/guides/prog_guide/multi_proc_support.rst | 4 ++-- doc/guides/rel_notes/known_issues.rst | 4 ++-- doc/guides/rel_notes/release_2_1.rst | 2 +- doc/guides/sample_app_ug/bbdev_app.rst | 6 +++--- doc/guides/sample_app_ug/ipsec_secgw.rst | 4 ++-- doc/guides/sample_app_ug/l3_forward.rst | 2 +- .../sample_app_ug/l3_forward_access_ctrl.rst | 2 +- 26 files changed, 57 insertions(+), 58 deletions(-) diff --git a/doc/guides/cryptodevs/dpaa2_sec.rst b/doc/guides/cryptodevs/dpaa2_sec.rst index 3053636b8295..363c52f0422f 100644 --- a/doc/guides/cryptodevs/dpaa2_sec.rst +++ b/doc/guides/cryptodevs/dpaa2_sec.rst @@ -134,10 +134,10 @@ Supported DPAA2 SoCs * LS2088A/LS2048A * LS1088A/LS1048A -Whitelisting & Blacklisting +Allowlisting & Blocklisting --------------------------- -For blacklisting a DPAA2 SEC device, following commands can be used. +The DPAA2 SEC device can be blocked with the following: .. code-block:: console diff --git a/doc/guides/cryptodevs/dpaa_sec.rst b/doc/guides/cryptodevs/dpaa_sec.rst index db3c8e918945..295164523d22 100644 --- a/doc/guides/cryptodevs/dpaa_sec.rst +++ b/doc/guides/cryptodevs/dpaa_sec.rst @@ -82,10 +82,10 @@ Supported DPAA SoCs * LS1046A/LS1026A * LS1043A/LS1023A -Whitelisting & Blacklisting +Allowlisting & Blocklisting --------------------------- -For blacklisting a DPAA device, following commands can be used. +For blocking a DPAA device, following commands can be used. .. code-block:: console diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst index c2cc3d5cae14..524a25adb644 100644 --- a/doc/guides/cryptodevs/qat.rst +++ b/doc/guides/cryptodevs/qat.rst @@ -122,7 +122,7 @@ Limitations optimisations in the GEN3 device. And if a GCM session is initialised on a GEN3 device, then attached to an op sent to a GEN1/GEN2 device, it will not be enqueued to the device and will be marked as failed. The simplest way to - mitigate this is to use the bdf whitelist to avoid mixing devices of different + mitigate this is to use the bdf allowlist to avoid mixing devices of different generations in the same process if planning to use for GCM. * The mixed algo feature on GEN2 is not supported by all kernel drivers. Check the notes under the Available Kernel Drivers table below for specific details. @@ -253,7 +253,7 @@ adjusted to the number of VFs which the QAT common code will need to handle. QAT VF may expose two crypto devices, sym and asym, it may happen that the number of devices will be bigger than MAX_DEVS and the process will show an error during PMD initialisation. To avoid this problem CONFIG_RTE_CRYPTO_MAX_DEVS may be - increased or -w, pci-whitelist domain:bus:devid:func option may be used. + increased or -w, pci-allowlist domain:bus:devid:func option may be used. QAT compression PMD needs intermediate buffers to support Deflate compression diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst b/doc/guides/freebsd_gsg/build_sample_apps.rst index 2a68f5fc3820..4fba671e4f5b 100644 --- a/doc/guides/freebsd_gsg/build_sample_apps.rst +++ b/doc/guides/freebsd_gsg/build_sample_apps.rst @@ -67,7 +67,7 @@ DPDK application. Some of the EAL options for FreeBSD are as follows: is a list of cores to use instead of a core mask. * ``-b ``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``: diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst index 2f606535c374..ebc6e3e02d74 100644 --- a/doc/guides/linux_gsg/build_sample_apps.rst +++ b/doc/guides/linux_gsg/build_sample_apps.rst @@ -102,7 +102,7 @@ The EAL options are as follows: Number of memory channels per processor socket. * ``-b ``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``: diff --git a/doc/guides/linux_gsg/eal_args.include.rst b/doc/guides/linux_gsg/eal_args.include.rst index 0fe44579689b..2f79cb891e10 100644 --- a/doc/guides/linux_gsg/eal_args.include.rst +++ b/doc/guides/linux_gsg/eal_args.include.rst @@ -44,20 +44,20 @@ Lcore-related options Device-related options ~~~~~~~~~~~~~~~~~~~~~~ -* ``-b, --pci-blacklist <[domain:]bus:devid.func>`` +* ``-b, --pci-blocklist <[domain:]bus:devid.func>`` - Blacklist a PCI device to prevent EAL from using it. Multiple -b options are - allowed. + Add a PCI device to the block list to prevent EAL from using it. + Multiple -b options are allowed. .. Note:: - PCI blacklist cannot be used with ``-w`` option. + PCI blocklist cannot be used with the allow list ``-w`` option. -* ``-w, --pci-whitelist <[domain:]bus:devid.func>`` +* ``-w, --pci-allowlist <[domain:]bus:devid.func>`` - Add a PCI device in white list. + Add a PCI device in to the allow list. .. Note:: - PCI whitelist cannot be used with ``-b`` option. + PCI allowlist cannot be used with the block list ``-b`` option. * ``--vdev `` diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index ed650187e0d7..cf273c86b2be 100644 --- a/doc/guides/nics/bnxt.rst +++ b/doc/guides/nics/bnxt.rst @@ -277,7 +277,7 @@ Unicast MAC Filter ^^^^^^^^^^^^^^^^^^ The application adds (or removes) MAC addresses to enable (or disable) -whitelist filtering to accept packets. +allowlist filtering to accept packets. .. code-block:: console @@ -288,7 +288,7 @@ Multicast MAC Filter ^^^^^^^^^^^^^^^^^^^^ Application adds (or removes) Multicast addresses to enable (or disable) -whitelist filtering to accept packets. +allowlist filtering to accept packets. .. code-block:: console @@ -296,7 +296,7 @@ whitelist filtering to accept packets. testpmd> mcast_addr (add|remove) (port_id) (XX:XX:XX:XX:XX:XX) Application adds (or removes) Multicast addresses to enable (or disable) -whitelist filtering to accept packets. +allowlist filtering to accept packets. Note that the BNXT PMD supports up to 16 MC MAC filters. if the user adds more than 16 MC MACs, the BNXT PMD puts the port into the Allmulticast mode. diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index 54a4c138998c..9aabf346060b 100644 --- a/doc/guides/nics/cxgbe.rst +++ b/doc/guides/nics/cxgbe.rst @@ -40,8 +40,8 @@ expose a single PCI bus address, thus, librte_pmd_cxgbe registers itself as a PCI driver that allocates one Ethernet device per detected port. -For this reason, one cannot whitelist/blacklist a single port without -whitelisting/blacklisting the other ports on the same device. +For this reason, one cannot allowlist/blocklist a single port without +allowlisting/blocklisting the other ports on the same device. .. _t5-nics: diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst index 17839a920e60..efcbb7207734 100644 --- a/doc/guides/nics/dpaa.rst +++ b/doc/guides/nics/dpaa.rst @@ -162,10 +162,10 @@ Manager. this pool. -Whitelisting & Blacklisting +Allowlisting & Blocklisting --------------------------- -For blacklisting a DPAA device, following commands can be used. +For blocking a DPAA device, following commands can be used. .. code-block:: console diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index fdfa6fdd5aea..91b5c59f8c0f 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -527,10 +527,10 @@ which are lower than logging ``level``. Using ``pmd.net.dpaa2`` as log matching criteria, all PMD logs can be enabled which are lower than logging ``level``. -Whitelisting & Blacklisting +Allowlisting & Blocklisting --------------------------- -For blacklisting a DPAA2 device, following commands can be used. +For blocking a DPAA2 device, following commands can be used. .. code-block:: console diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index a28a7f4e477a..69bcfd5c8576 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -187,14 +187,14 @@ or ``vfio`` in non-IOMMU mode. In the VM, the kernel enic driver may be automatically bound to the VF during boot. Unbinding it currently hangs due to a known issue with the driver. To -work around the issue, blacklist the enic module as follows. +work around the issue, blocklist the enic module as follows. Please see :ref:`Limitations ` for limitations in the use of SR-IOV. .. code-block:: console # cat /etc/modprobe.d/enic.conf - blacklist enic + blocklist enic # dracut --force @@ -437,7 +437,7 @@ PKT_RX_VLAN_STRIPPED mbuf flags would not be set. This mode is enabled with the - VF devices are not usable directly from the host. They can only be used as assigned devices on VM instances. - Currently, unbind of the ENIC kernel mode driver 'enic.ko' on the VM - instance may hang. As a workaround, enic.ko should be blacklisted or removed + instance may hang. As a workaround, enic.ko should be blocklisted or removed from the boot process. - pci_generic cannot be used as the uio module in the VM. igb_uio or vfio in non-IOMMU mode can be used. diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst index b4a92f663b17..01ad66bec774 100644 --- a/doc/guides/nics/fail_safe.rst +++ b/doc/guides/nics/fail_safe.rst @@ -68,11 +68,11 @@ Fail-safe command line parameters .. note:: - In case where the sub-device is also used as a whitelist device, using ``-w`` + In case where the sub-device is also used as a allowlist device, using ``-w`` on the EAL command line, the fail-safe PMD will use the device with the options provided to the EAL instead of its own parameters. - When trying to use a PCI device automatically probed by the blacklist mode, + When trying to use a PCI device automatically probed by the blocklist mode, the name for the fail-safe sub-device must be the full PCI id: Domain:Bus:Device.Function, *i.e.* ``00:00:00.0`` instead of ``00:00.0``, as the second form is historically accepted by the DPDK. @@ -123,8 +123,8 @@ This section shows some example of using **testpmd** with a fail-safe PMD. #. To build a PMD and configure DPDK, refer to the document :ref:`compiling and testing a PMD for a NIC `. -#. Start testpmd. The sub-device ``84:00.0`` should be blacklisted from normal EAL - operations to avoid probing it twice, as the PCI bus is in blacklist mode. +#. Start testpmd. The sub-device ``84:00.0`` should be blocklisted from normal EAL + operations to avoid probing it twice, as the PCI bus is in blocklist mode. .. code-block:: console @@ -132,13 +132,13 @@ This section shows some example of using **testpmd** with a fail-safe PMD. --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ -b 84:00.0 -b 00:04.0 -- -i - If the sub-device ``84:00.0`` is not blacklisted, it will be probed by the + If the sub-device ``84:00.0`` is not blocklisted, it will be probed by the EAL first. When the fail-safe then tries to initialize it the probe operation fails. - Note that PCI blacklist mode is the default PCI operating mode. + Note that PCI blocklist mode is the default PCI operating mode. -#. Alternatively, it can be used alongside any other device in whitelist mode. +#. Alternatively, it can be used alongside any other device in allowlist mode. .. code-block:: console diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index edd21c4d8e9d..6aecead6e019 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -247,7 +247,7 @@ Supports enabling/disabling receiving multicast frames. Unicast MAC filter ------------------ -Supports adding MAC addresses to enable whitelist filtering to accept packets. +Supports adding MAC addresses to enable allowlist filtering to accept packets. * **[implements] eth_dev_ops**: ``mac_addr_set``, ``mac_addr_add``, ``mac_addr_remove``. * **[implements] rte_eth_dev_data**: ``mac_addrs``. diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst index 9a9f4a6bb093..865718fb83cd 100644 --- a/doc/guides/nics/ice.rst +++ b/doc/guides/nics/ice.rst @@ -61,7 +61,7 @@ Runtime Config Options In pipeline mode, a flow can be set at one specific stage by setting parameter ``priority``. Currently, we support two stages: priority = 0 or !0. Flows with priority 0 located at the first pipeline stage which typically be used as a firewall - to drop the packet on a blacklist(we called it permission stage). At this stage, + to drop the packet on a blocklist(we called it permission stage). At this stage, flow rules are created for the device's exact match engine: switch. Flows with priority !0 located at the second stage, typically packets are classified here and be steered to specific queue or queue group (we called it distribution stage), At this stage, flow diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index 1f1e2f6c7767..dfdccb4aab7c 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -29,8 +29,8 @@ Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI bus address, thus unlike most drivers, librte_pmd_mlx4 registers itself as a PCI driver that allocates one Ethernet device per detected port. -For this reason, one cannot white/blacklist a single port without also -white/blacklisting the others on the same device. +For this reason, one cannot white/blocklist a single port without also +white/blocklisting the others on the same device. Besides its dependency on libibverbs (that implies libmlx4 and associated kernel support), librte_pmd_mlx4 relies heavily on system calls for control @@ -422,7 +422,7 @@ devices managed by librte_pmd_mlx4. eth4 eth5 -#. Optionally, retrieve their PCI bus addresses for whitelisting:: +#. Optionally, retrieve their PCI bus addresses for allowlisting:: { for intf in eth2 eth3 eth4 eth5; diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index bb03df66a84a..22f1598be06d 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -1424,7 +1424,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5. eth32 eth33 -#. Optionally, retrieve their PCI bus addresses for whitelisting:: +#. Optionally, retrieve their PCI bus addresses for allowlisting:: { for intf in eth2 eth3 eth4 eth5; diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index be1c2fe1d67e..44115a666a94 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -290,7 +290,7 @@ Per-Device Parameters ~~~~~~~~~~~~~~~~~~~~~ The following per-device parameters can be passed via EAL PCI device -whitelist option like "-w 02:00.0,arg1=value1,...". +allowlist option like "-w 02:00.0,arg1=value1,...". Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify boolean parameters value. diff --git a/doc/guides/nics/tap.rst b/doc/guides/nics/tap.rst index 7e44f846206c..0e726bf87f73 100644 --- a/doc/guides/nics/tap.rst +++ b/doc/guides/nics/tap.rst @@ -191,7 +191,7 @@ following:: .. Note: - Change the ``-b`` options to blacklist all of your physical ports. The + Change the ``-b`` options to blocklist all of your physical ports. The following command line is all one line. Also, ``-f themes/black-yellow.theme`` is optional if the default colors diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index 48a2fec066db..0b60ef987db0 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -407,12 +407,11 @@ device having emitted a Device Removal Event. In such case, calling callback. Care must be taken not to close the device from the interrupt handler context. It is necessary to reschedule such closing operation. -Blacklisting +Blocklisting ~~~~~~~~~~~~ -The EAL PCI device blacklist functionality can be used to mark certain NIC ports as blacklisted, -so they are ignored by the DPDK. -The ports to be blacklisted are identified using the PCIe* description (Domain:Bus:Device.Function). +The EAL PCI device blocklist functionality can be used to mark certain NIC ports as unavailale, so they are ignored by the DPDK. +The ports to be blocklisted are identified using the PCIe* description (Domain:Bus:Device.Function). Misc Functions ~~~~~~~~~~~~~~ diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst index a84083b96c8a..14cb6db85661 100644 --- a/doc/guides/prog_guide/multi_proc_support.rst +++ b/doc/guides/prog_guide/multi_proc_support.rst @@ -30,7 +30,7 @@ after a primary process has already configured the hugepage shared memory for th Secondary processes should run alongside primary process with same DPDK version. Secondary processes which requires access to physical devices in Primary process, must - be passed with the same whitelist and blacklist options. + be passed with the same allowlist and blocklist options. To support these two process types, and other multi-process setups described later, two additional command-line parameters are available to the EAL: @@ -131,7 +131,7 @@ can use). .. note:: Independent DPDK instances running side-by-side on a single machine cannot share any network ports. - Any network ports being used by one process should be blacklisted in every other process. + Any network ports being used by one process should be blocklisted in every other process. Running Multiple Independent Groups of DPDK Applications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst index de0782136d3c..83a3b38c0ae0 100644 --- a/doc/guides/rel_notes/known_issues.rst +++ b/doc/guides/rel_notes/known_issues.rst @@ -523,8 +523,8 @@ Devices bound to igb_uio with VT-d enabled do not work on Linux kernel 3.15-3.17 DMAR:[fault reason 02] Present bit in context entry is clear **Resolution/Workaround**: - Use earlier or later kernel versions, or avoid driver binding on boot by blacklisting the driver modules. - I.e., in the case of ``ixgbe``, we can pass the kernel command line option: ``modprobe.blacklist=ixgbe``. + Use earlier or later kernel versions, or avoid driver binding on boot by blocklisting the driver modules. + I.e., in the case of ``ixgbe``, we can pass the kernel command line option: ``modprobe.blocklist=ixgbe``. This way we do not need to unbind the device to bind it to igb_uio. **Affected Environment/Platform**: diff --git a/doc/guides/rel_notes/release_2_1.rst b/doc/guides/rel_notes/release_2_1.rst index beadc51ba438..6339172c64fa 100644 --- a/doc/guides/rel_notes/release_2_1.rst +++ b/doc/guides/rel_notes/release_2_1.rst @@ -472,7 +472,7 @@ Resolved Issues * **devargs: Fix crash on failure.** - This problem occurred when passing an invalid PCI id to the blacklist API in + This problem occurred when passing an invalid PCI id to the blocklist API in devargs. diff --git a/doc/guides/sample_app_ug/bbdev_app.rst b/doc/guides/sample_app_ug/bbdev_app.rst index 405e706a46e4..b722d0263772 100644 --- a/doc/guides/sample_app_ug/bbdev_app.rst +++ b/doc/guides/sample_app_ug/bbdev_app.rst @@ -79,7 +79,7 @@ This means that HW baseband device/s must be bound to a DPDK driver or a SW baseband device/s (virtual BBdev) must be created (using --vdev). To run the application in linux environment with the turbo_sw baseband device -using the whitelisted port running on 1 encoding lcore and 1 decoding lcore +using the allowlisted port running on 1 encoding lcore and 1 decoding lcore issue the command: .. code-block:: console @@ -90,7 +90,7 @@ issue the command: where, NIC0PCIADDR is the PCI address of the Rx port This command creates one virtual bbdev devices ``baseband_turbo_sw`` where the -device gets linked to a corresponding ethernet port as whitelisted by +device gets linked to a corresponding ethernet port as allowlisted by the parameter -w. 3 cores are allocated to the application, and assigned as: @@ -111,7 +111,7 @@ Using Packet Generator with baseband device sample application To allow the bbdev sample app to do the loopback, an influx of traffic is required. This can be done by using DPDK Pktgen to burst traffic on two ethernet ports, and it will print the transmitted along with the looped-back traffic on Rx ports. -Executing the command below will generate traffic on the two whitelisted ethernet +Executing the command below will generate traffic on the two allowlisted ethernet ports. .. code-block:: console diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst index 81c5d4360615..bf1aefc0e120 100644 --- a/doc/guides/sample_app_ug/ipsec_secgw.rst +++ b/doc/guides/sample_app_ug/ipsec_secgw.rst @@ -329,8 +329,8 @@ This means that if the application is using a single core and both hardware and software crypto devices are detected, hardware devices will be used. A way to achieve the case where you want to force the use of virtual crypto -devices is to whitelist the Ethernet devices needed and therefore implicitly -blacklisting all hardware crypto devices. +devices is to allowlist the Ethernet devices needed and therefore implicitly +blocklisting all hardware crypto devices. For example, something like the following command line: diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst index 07c8d44936d6..69a29ab1314e 100644 --- a/doc/guides/sample_app_ug/l3_forward.rst +++ b/doc/guides/sample_app_ug/l3_forward.rst @@ -148,7 +148,7 @@ or In this command: -* -w option whitelist the event device supported by platform. Way to pass this device may vary based on platform. +* -w option allowlist the event device supported by platform. Way to pass this device may vary based on platform. * The --mode option defines PMD to be used for packet I/O. diff --git a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst index a44fbcd52c3a..473326275e49 100644 --- a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst +++ b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst @@ -18,7 +18,7 @@ The application loads two types of rules at initialization: * Route information rules, which are used for L3 forwarding -* Access Control List (ACL) rules that blacklist (or block) packets with a specific characteristic +* Access Control List (ACL) rules that blocklist (or block) packets with a specific characteristic When packets are received from a port, the application extracts the necessary information from the TCP/IP header of the received packet and -- 2.26.2