[7/8] doc: change reference to allowlist relative to MAC filtering
diff mbox series

Message ID 20200922143202.8755-8-stephen@networkplumber.org
State Superseded
Delegated to: Thomas Monjalon
Headers show
Series
  • replace blacklist/whitelist with block/allow
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Stephen Hemminger Sept. 22, 2020, 2:32 p.m. UTC
Avoid potential confusion in documentation around allow option
for bus addresses by rewording the text around MAC address filtering.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/nics/bnxt.rst     | 11 ++++-------
 doc/guides/nics/features.rst |  2 +-
 doc/guides/nics/mlx4.rst     |  2 +-
 doc/guides/nics/mlx5.rst     |  2 +-
 4 files changed, 7 insertions(+), 10 deletions(-)

Patch
diff mbox series

diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
index 627fe88f455d..1a78b5c74fbd 100644
--- a/doc/guides/nics/bnxt.rst
+++ b/doc/guides/nics/bnxt.rst
@@ -258,8 +258,8 @@  The BNXT PMD supports hardware-based packet filtering:
 Unicast MAC Filter
 ^^^^^^^^^^^^^^^^^^
 
-The application adds (or removes) MAC addresses to enable (or disable)
-allowlist filtering to accept packets.
+The application adds (or removes) MAC addresses that enable (or disable)
+filtering on MAC address used to accept packets.
 
 .. code-block:: console
 
@@ -269,17 +269,14 @@  allowlist filtering to accept packets.
 Multicast MAC Filter
 ^^^^^^^^^^^^^^^^^^^^
 
-Application adds (or removes) Multicast addresses to enable (or disable)
-allowlist filtering to accept packets.
+Application adds (or removes) Multicast addresses that enable (or disable)
+filtering on multicast MAC address used to accept packets.
 
 .. code-block:: console
 
     testpmd> show port (port_id) mcast_macs
     testpmd> mcast_addr (add|remove) (port_id) (XX:XX:XX:XX:XX:XX)
 
-Application adds (or removes) Multicast addresses to enable (or disable)
-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/features.rst b/doc/guides/nics/features.rst
index 6aecead6e019..19b6e7e3312f 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 allowlist filtering to accept packets.
+Supports adding MAC addresses to filter.
 
 * **[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/mlx4.rst b/doc/guides/nics/mlx4.rst
index dfdccb4aab7c..13c598ef39b8 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -422,7 +422,7 @@  devices managed by librte_pmd_mlx4.
       eth4
       eth5
 
-#. Optionally, retrieve their PCI bus addresses for allowlisting::
+#. Optionally, retrieve their PCI bus addresses for use in allow argument::
 
       {
           for intf in eth2 eth3 eth4 eth5;
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index d24f70428e4c..fc0f3fc57f70 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1526,7 +1526,7 @@  ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
       eth32
       eth33
 
-#. Optionally, retrieve their PCI bus addresses for allowlisting::
+#. Optionally, retrieve their PCI bus addresses for use in allow list::
 
       {
           for intf in eth2 eth3 eth4 eth5;