[v4,00/11] rename blacklist/whitelist to exclude/include
mbox series

Message ID 20200714053919.5609-1-stephen@networkplumber.org
Headers show
Series
  • rename blacklist/whitelist to exclude/include
Related show

Message

Stephen Hemminger July 14, 2020, 5:39 a.m. UTC
The terms blacklist and whitelist are often seen as reminders
of the divisions in society. Instead, use more exact terms for
handling of which devices are used in DPDK.

This is a proposed change for DPDK 20.08 to replace the names
blacklist and whitelist in API and command lines.

The first three patches fix some other unnecessary use of
blacklist/whitelist and have no user visible impact.

The rest change the PCI blacklist to be blocklist and
whitelist to be allowlist.

Thank you for the support and review of this patch.

v4 - change to use pci-include/pci-exclude for options
     incorporate review feedback
     keep old options (with approporiate deprecation notice)
     update examples in doc

Stephen Hemminger (11):
  rte_ethdev: change comment to rte_dev_eth_mac_addr_add
  mk: replace reference to blacklist/whitelist
  check_maintainers: change variable names
  eal: replace usage of blacklist/whitelist in enum
  drivers: replace references to blacklist
  eal: replace pci-whitelist/pci-blacklist options
  doc: replace references to blacklist/whitelist
  app/test: use new allowlist and blocklist
  doc: add note about blacklist/whitelist changes
  eal: mark old macros for blacklist/whitelist as deprecated
  doc: update examples to new config options

 app/test/autotest.py                          | 16 ++---
 app/test/autotest_runner.py                   | 18 +++---
 app/test/test.c                               |  2 +-
 app/test/test_eal_flags.c                     | 52 ++++++++--------
 devtools/check-maintainers.sh                 |  8 +--
 doc/guides/cryptodevs/dpaa2_sec.rst           |  4 +-
 doc/guides/cryptodevs/dpaa_sec.rst            |  4 +-
 doc/guides/cryptodevs/qat.rst                 |  6 +-
 doc/guides/eventdevs/octeontx2.rst            | 20 +++----
 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/linux_gsg/linux_drivers.rst        |  4 +-
 doc/guides/mempool/octeontx2.rst              |  4 +-
 doc/guides/nics/bnxt.rst                      |  6 +-
 doc/guides/nics/cxgbe.rst                     | 12 ++--
 doc/guides/nics/dpaa.rst                      |  4 +-
 doc/guides/nics/dpaa2.rst                     |  4 +-
 doc/guides/nics/enic.rst                      | 12 ++--
 doc/guides/nics/fail_safe.rst                 | 18 +++---
 doc/guides/nics/features.rst                  |  2 +-
 doc/guides/nics/i40e.rst                      | 12 ++--
 doc/guides/nics/ice.rst                       | 18 +++---
 doc/guides/nics/mlx4.rst                      | 16 ++---
 doc/guides/nics/mlx5.rst                      | 12 ++--
 doc/guides/nics/octeontx2.rst                 | 22 +++----
 doc/guides/nics/sfc_efx.rst                   |  2 +-
 doc/guides/nics/tap.rst                       | 10 ++--
 doc/guides/nics/thunderx.rst                  |  4 +-
 .../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_20_08.rst        |  6 ++
 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      |  6 +-
 doc/guides/sample_app_ug/l3_forward.rst       |  2 +-
 .../sample_app_ug/l3_forward_access_ctrl.rst  |  2 +-
 .../sample_app_ug/l3_forward_power_man.rst    |  2 +-
 doc/guides/sample_app_ug/vdpa.rst             |  2 +-
 doc/guides/tools/cryptoperf.rst               |  6 +-
 doc/guides/tools/flow-perf.rst                |  2 +-
 drivers/bus/dpaa/dpaa_bus.c                   |  7 +--
 drivers/bus/fslmc/fslmc_bus.c                 |  9 ++-
 drivers/bus/fslmc/fslmc_vfio.c                |  8 +--
 drivers/bus/pci/pci_common.c                  | 24 ++++----
 drivers/bus/vmbus/vmbus_common.c              |  4 +-
 drivers/crypto/virtio/virtio_pci.c            |  2 +-
 drivers/net/fm10k/fm10k_ethdev.c              |  2 +-
 drivers/net/virtio/virtio_pci.c               |  2 +-
 lib/librte_eal/common/eal_common_devargs.c    | 14 ++---
 lib/librte_eal/common/eal_common_options.c    | 59 ++++++++++++-------
 lib/librte_eal/common/eal_options.h           |  8 ++-
 lib/librte_eal/include/rte_bus.h              | 13 +++-
 lib/librte_eal/include/rte_dev.h              | 12 +++-
 lib/librte_eal/include/rte_devargs.h          | 12 +++-
 lib/librte_ethdev/rte_ethdev.h                |  3 +-
 mk/rte.sdktest.mk                             | 14 ++---
 58 files changed, 299 insertions(+), 255 deletions(-)

Comments

Stephen Hemminger July 14, 2020, 6:05 a.m. UTC | #1
On Mon, 13 Jul 2020 22:39:08 -0700
Stephen Hemminger <stephen@networkplumber.org> wrote:

> The terms blacklist and whitelist are often seen as reminders
> of the divisions in society. Instead, use more exact terms for
> handling of which devices are used in DPDK.
> 
> This is a proposed change for DPDK 20.08 to replace the names
> blacklist and whitelist in API and command lines.
> 
> The first three patches fix some other unnecessary use of
> blacklist/whitelist and have no user visible impact.
> 
> The rest change the PCI blacklist to be blocklist and
> whitelist to be allowlist.
> 
> Thank you for the support and review of this patch.
> 
> v4 - change to use pci-include/pci-exclude for options
>      incorporate review feedback
>      keep old options (with approporiate deprecation notice)
>      update examples in doc
> 
> Stephen Hemminger (11):
>   rte_ethdev: change comment to rte_dev_eth_mac_addr_add
>   mk: replace reference to blacklist/whitelist
>   check_maintainers: change variable names
>   eal: replace usage of blacklist/whitelist in enum
>   drivers: replace references to blacklist
>   eal: replace pci-whitelist/pci-blacklist options
>   doc: replace references to blacklist/whitelist
>   app/test: use new allowlist and blocklist
>   doc: add note about blacklist/whitelist changes
>   eal: mark old macros for blacklist/whitelist as deprecated
>   doc: update examples to new config options
> 
>  app/test/autotest.py                          | 16 ++---
>  app/test/autotest_runner.py                   | 18 +++---
>  app/test/test.c                               |  2 +-
>  app/test/test_eal_flags.c                     | 52 ++++++++--------
>  devtools/check-maintainers.sh                 |  8 +--
>  doc/guides/cryptodevs/dpaa2_sec.rst           |  4 +-
>  doc/guides/cryptodevs/dpaa_sec.rst            |  4 +-
>  doc/guides/cryptodevs/qat.rst                 |  6 +-
>  doc/guides/eventdevs/octeontx2.rst            | 20 +++----
>  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/linux_gsg/linux_drivers.rst        |  4 +-
>  doc/guides/mempool/octeontx2.rst              |  4 +-
>  doc/guides/nics/bnxt.rst                      |  6 +-
>  doc/guides/nics/cxgbe.rst                     | 12 ++--
>  doc/guides/nics/dpaa.rst                      |  4 +-
>  doc/guides/nics/dpaa2.rst                     |  4 +-
>  doc/guides/nics/enic.rst                      | 12 ++--
>  doc/guides/nics/fail_safe.rst                 | 18 +++---
>  doc/guides/nics/features.rst                  |  2 +-
>  doc/guides/nics/i40e.rst                      | 12 ++--
>  doc/guides/nics/ice.rst                       | 18 +++---
>  doc/guides/nics/mlx4.rst                      | 16 ++---
>  doc/guides/nics/mlx5.rst                      | 12 ++--
>  doc/guides/nics/octeontx2.rst                 | 22 +++----
>  doc/guides/nics/sfc_efx.rst                   |  2 +-
>  doc/guides/nics/tap.rst                       | 10 ++--
>  doc/guides/nics/thunderx.rst                  |  4 +-
>  .../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_20_08.rst        |  6 ++
>  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      |  6 +-
>  doc/guides/sample_app_ug/l3_forward.rst       |  2 +-
>  .../sample_app_ug/l3_forward_access_ctrl.rst  |  2 +-
>  .../sample_app_ug/l3_forward_power_man.rst    |  2 +-
>  doc/guides/sample_app_ug/vdpa.rst             |  2 +-
>  doc/guides/tools/cryptoperf.rst               |  6 +-
>  doc/guides/tools/flow-perf.rst                |  2 +-
>  drivers/bus/dpaa/dpaa_bus.c                   |  7 +--
>  drivers/bus/fslmc/fslmc_bus.c                 |  9 ++-
>  drivers/bus/fslmc/fslmc_vfio.c                |  8 +--
>  drivers/bus/pci/pci_common.c                  | 24 ++++----
>  drivers/bus/vmbus/vmbus_common.c              |  4 +-
>  drivers/crypto/virtio/virtio_pci.c            |  2 +-
>  drivers/net/fm10k/fm10k_ethdev.c              |  2 +-
>  drivers/net/virtio/virtio_pci.c               |  2 +-
>  lib/librte_eal/common/eal_common_devargs.c    | 14 ++---
>  lib/librte_eal/common/eal_common_options.c    | 59 ++++++++++++-------
>  lib/librte_eal/common/eal_options.h           |  8 ++-
>  lib/librte_eal/include/rte_bus.h              | 13 +++-
>  lib/librte_eal/include/rte_dev.h              | 12 +++-
>  lib/librte_eal/include/rte_devargs.h          | 12 +++-
>  lib/librte_ethdev/rte_ethdev.h                |  3 +-
>  mk/rte.sdktest.mk                             | 14 ++---
>  58 files changed, 299 insertions(+), 255 deletions(-)
> 

There are some bogus checkpatch complaints against patches in this
series.  The new linux kernel checkpatch now complains about whitelist/blacklist
so any attempt to fix would hit that.

Also, Linux kernel checkpatch now wants the magic
          fallthrough;
which in Linux kernel is a macro but does not exist in DPDK.
Someone want to fix checkpatch for that one?