mbox series

[v9,0/6] replace blacklist/whitelist with allow/block

Message ID 20201105223602.5965-1-stephen@networkplumber.org (mailing list archive)
Headers
Series replace blacklist/whitelist with allow/block |

Message

Stephen Hemminger Nov. 5, 2020, 10:35 p.m. UTC 
  This patch series changes the use of the terms blacklist and whitelist
and instead uses block and allow.  The change is most visible
in the options passed to DPDK programs for marking which devices
to use.

The options are also shortened because they can be used for
not just PCI devices. When DPDK was expanded to support other bus
types the -b option was also uses for non-PCI devices. But the
documentation and the name of the long option never changed.

v9 - rebase to main and use  the feedback from David Marchand
     fix some more leftover places where previous names
     where still in documentation, comments, help etc.
     split out release note (so people look at it)

v8 - incorporate more of the feedback from David Marchand
     fix the pci-blacklist option number and reformat the usage
     (All the usage message should be fixed format).

v7 - fix options handling changes in test code.
     this should fix the CI failures.

Stephen Hemminger (6):
  eal: replace usage of blacklist/whitelist in enum
  drivers: replace references to blacklist
  eal: replace pci-whitelist/pci-blacklist options
  app/test: use new allowlist and blocklist
  doc: change references to blacklist and whitelist
  doc: update release notes now for block allow changes

 app/test/autotest.py                          | 16 ++---
 app/test/autotest_runner.py                   | 18 ++---
 app/test/test.c                               |  2 +-
 app/test/test_eal_flags.c                     | 53 +++++++--------
 doc/guides/cryptodevs/dpaa2_sec.rst           |  6 +-
 doc/guides/cryptodevs/dpaa_sec.rst            |  6 +-
 doc/guides/cryptodevs/qat.rst                 | 12 ++--
 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                      | 18 ++---
 doc/guides/nics/cxgbe.rst                     | 12 ++--
 doc/guides/nics/dpaa.rst                      |  6 +-
 doc/guides/nics/dpaa2.rst                     |  6 +-
 doc/guides/nics/enic.rst                      |  6 +-
 doc/guides/nics/fail_safe.rst                 | 20 +++---
 doc/guides/nics/features.rst                  |  2 +-
 doc/guides/nics/i40e.rst                      | 16 ++---
 doc/guides/nics/ice.rst                       | 16 ++---
 doc/guides/nics/ixgbe.rst                     |  4 +-
 doc/guides/nics/mlx4.rst                      | 18 ++---
 doc/guides/nics/mlx5.rst                      | 14 ++--
 doc/guides/nics/nfb.rst                       |  2 +-
 doc/guides/nics/octeontx2.rst                 | 23 +++----
 doc/guides/nics/sfc_efx.rst                   |  2 +-
 doc/guides/nics/tap.rst                       |  2 +-
 doc/guides/nics/thunderx.rst                  |  4 +-
 .../prog_guide/env_abstraction_layer.rst      |  8 +--
 doc/guides/prog_guide/multi_proc_support.rst  |  4 +-
 doc/guides/prog_guide/poll_mode_drv.rst       |  6 +-
 .../prog_guide/switch_representation.rst      |  6 +-
 doc/guides/rel_notes/deprecation.rst          | 23 -------
 doc/guides/rel_notes/release_20_11.rst        | 11 ++++
 doc/guides/sample_app_ug/bbdev_app.rst        | 14 ++--
 .../sample_app_ug/eventdev_pipeline.rst       |  4 +-
 doc/guides/sample_app_ug/ipsec_secgw.rst      | 12 ++--
 doc/guides/sample_app_ug/l3_forward.rst       |  7 +-
 .../sample_app_ug/l3_forward_access_ctrl.rst  |  2 +-
 .../sample_app_ug/l3_forward_power_man.rst    |  3 +-
 doc/guides/sample_app_ug/vdpa.rst             |  2 +-
 doc/guides/tools/cryptoperf.rst               |  6 +-
 doc/guides/tools/flow-perf.rst                |  2 +-
 doc/guides/tools/testregex.rst                |  2 +-
 drivers/bus/dpaa/dpaa_bus.c                   |  7 +-
 drivers/bus/fslmc/fslmc_bus.c                 |  9 ++-
 drivers/bus/fslmc/fslmc_vfio.c                | 12 ++--
 drivers/bus/pci/pci_common.c                  | 24 +++----
 drivers/bus/vmbus/vmbus_common.c              |  4 +-
 drivers/crypto/virtio/virtio_pci.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    | 66 +++++++++++--------
 lib/librte_eal/common/eal_options.h           | 13 +++-
 lib/librte_eal/include/rte_bus.h              | 10 ++-
 lib/librte_eal/include/rte_dev.h              | 10 ++-
 lib/librte_eal/include/rte_devargs.h          | 10 ++-
 59 files changed, 326 insertions(+), 299 deletions(-)

Comments

Luca Boccassi Nov. 10, 2020, 1:56 p.m. UTC | #1 
On Thu, 2020-11-05 at 14:35 -0800, Stephen Hemminger wrote:
> This patch series changes the use of the terms blacklist and whitelist
> and instead uses block and allow.  The change is most visible
> in the options passed to DPDK programs for marking which devices
> to use.
> 
> The options are also shortened because they can be used for
> not just PCI devices. When DPDK was expanded to support other bus
> types the -b option was also uses for non-PCI devices. But the
> documentation and the name of the long option never changed.
> 
> v9 - rebase to main and use  the feedback from David Marchand
>      fix some more leftover places where previous names
>      where still in documentation, comments, help etc.
>      split out release note (so people look at it)
> 
> v8 - incorporate more of the feedback from David Marchand
>      fix the pci-blacklist option number and reformat the usage
>      (All the usage message should be fixed format).
> 
> v7 - fix options handling changes in test code.
>      this should fix the CI failures.
> 
> Stephen Hemminger (6):
>   eal: replace usage of blacklist/whitelist in enum
>   drivers: replace references to blacklist
>   eal: replace pci-whitelist/pci-blacklist options
>   app/test: use new allowlist and blocklist
>   doc: change references to blacklist and whitelist
>   doc: update release notes now for block allow changes
> 
>  app/test/autotest.py                          | 16 ++---
>  app/test/autotest_runner.py                   | 18 ++---
>  app/test/test.c                               |  2 +-
>  app/test/test_eal_flags.c                     | 53 +++++++--------
>  doc/guides/cryptodevs/dpaa2_sec.rst           |  6 +-
>  doc/guides/cryptodevs/dpaa_sec.rst            |  6 +-
>  doc/guides/cryptodevs/qat.rst                 | 12 ++--
>  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                      | 18 ++---
>  doc/guides/nics/cxgbe.rst                     | 12 ++--
>  doc/guides/nics/dpaa.rst                      |  6 +-
>  doc/guides/nics/dpaa2.rst                     |  6 +-
>  doc/guides/nics/enic.rst                      |  6 +-
>  doc/guides/nics/fail_safe.rst                 | 20 +++---
>  doc/guides/nics/features.rst                  |  2 +-
>  doc/guides/nics/i40e.rst                      | 16 ++---
>  doc/guides/nics/ice.rst                       | 16 ++---
>  doc/guides/nics/ixgbe.rst                     |  4 +-
>  doc/guides/nics/mlx4.rst                      | 18 ++---
>  doc/guides/nics/mlx5.rst                      | 14 ++--
>  doc/guides/nics/nfb.rst                       |  2 +-
>  doc/guides/nics/octeontx2.rst                 | 23 +++----
>  doc/guides/nics/sfc_efx.rst                   |  2 +-
>  doc/guides/nics/tap.rst                       |  2 +-
>  doc/guides/nics/thunderx.rst                  |  4 +-
>  .../prog_guide/env_abstraction_layer.rst      |  8 +--
>  doc/guides/prog_guide/multi_proc_support.rst  |  4 +-
>  doc/guides/prog_guide/poll_mode_drv.rst       |  6 +-
>  .../prog_guide/switch_representation.rst      |  6 +-
>  doc/guides/rel_notes/deprecation.rst          | 23 -------
>  doc/guides/rel_notes/release_20_11.rst        | 11 ++++
>  doc/guides/sample_app_ug/bbdev_app.rst        | 14 ++--
>  .../sample_app_ug/eventdev_pipeline.rst       |  4 +-
>  doc/guides/sample_app_ug/ipsec_secgw.rst      | 12 ++--
>  doc/guides/sample_app_ug/l3_forward.rst       |  7 +-
>  .../sample_app_ug/l3_forward_access_ctrl.rst  |  2 +-
>  .../sample_app_ug/l3_forward_power_man.rst    |  3 +-
>  doc/guides/sample_app_ug/vdpa.rst             |  2 +-
>  doc/guides/tools/cryptoperf.rst               |  6 +-
>  doc/guides/tools/flow-perf.rst                |  2 +-
>  doc/guides/tools/testregex.rst                |  2 +-
>  drivers/bus/dpaa/dpaa_bus.c                   |  7 +-
>  drivers/bus/fslmc/fslmc_bus.c                 |  9 ++-
>  drivers/bus/fslmc/fslmc_vfio.c                | 12 ++--
>  drivers/bus/pci/pci_common.c                  | 24 +++----
>  drivers/bus/vmbus/vmbus_common.c              |  4 +-
>  drivers/crypto/virtio/virtio_pci.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    | 66 +++++++++++--------
>  lib/librte_eal/common/eal_options.h           | 13 +++-
>  lib/librte_eal/include/rte_bus.h              | 10 ++-
>  lib/librte_eal/include/rte_dev.h              | 10 ++-
>  lib/librte_eal/include/rte_devargs.h          | 10 ++-
>  59 files changed, 326 insertions(+), 299 deletions(-)
> 

I verified that no new build issues are introduced on various
distro/archs combination via OBS.
Bruce Richardson Nov. 10, 2020, 4:14 p.m. UTC | #2 
On Tue, Nov 10, 2020 at 01:56:42PM +0000, Luca Boccassi wrote:
> On Thu, 2020-11-05 at 14:35 -0800, Stephen Hemminger wrote:
> > This patch series changes the use of the terms blacklist and whitelist
> > and instead uses block and allow.  The change is most visible
> > in the options passed to DPDK programs for marking which devices
> > to use.
> > 
> > The options are also shortened because they can be used for
> > not just PCI devices. When DPDK was expanded to support other bus
> > types the -b option was also uses for non-PCI devices. But the
> > documentation and the name of the long option never changed.
> > 
> > v9 - rebase to main and use  the feedback from David Marchand
> >      fix some more leftover places where previous names
> >      where still in documentation, comments, help etc.
> >      split out release note (so people look at it)
> > 
> > v8 - incorporate more of the feedback from David Marchand
> >      fix the pci-blacklist option number and reformat the usage
> >      (All the usage message should be fixed format).
> > 
> > v7 - fix options handling changes in test code.
> >      this should fix the CI failures.
> > 
> > Stephen Hemminger (6):
> >   eal: replace usage of blacklist/whitelist in enum
> >   drivers: replace references to blacklist
> >   eal: replace pci-whitelist/pci-blacklist options
> >   app/test: use new allowlist and blocklist
> >   doc: change references to blacklist and whitelist
> >   doc: update release notes now for block allow changes
> > 
> >  app/test/autotest.py                          | 16 ++---
> >  app/test/autotest_runner.py                   | 18 ++---
> >  app/test/test.c                               |  2 +-
> >  app/test/test_eal_flags.c                     | 53 +++++++--------
> >  doc/guides/cryptodevs/dpaa2_sec.rst           |  6 +-
> >  doc/guides/cryptodevs/dpaa_sec.rst            |  6 +-
> >  doc/guides/cryptodevs/qat.rst                 | 12 ++--
> >  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                      | 18 ++---
> >  doc/guides/nics/cxgbe.rst                     | 12 ++--
> >  doc/guides/nics/dpaa.rst                      |  6 +-
> >  doc/guides/nics/dpaa2.rst                     |  6 +-
> >  doc/guides/nics/enic.rst                      |  6 +-
> >  doc/guides/nics/fail_safe.rst                 | 20 +++---
> >  doc/guides/nics/features.rst                  |  2 +-
> >  doc/guides/nics/i40e.rst                      | 16 ++---
> >  doc/guides/nics/ice.rst                       | 16 ++---
> >  doc/guides/nics/ixgbe.rst                     |  4 +-
> >  doc/guides/nics/mlx4.rst                      | 18 ++---
> >  doc/guides/nics/mlx5.rst                      | 14 ++--
> >  doc/guides/nics/nfb.rst                       |  2 +-
> >  doc/guides/nics/octeontx2.rst                 | 23 +++----
> >  doc/guides/nics/sfc_efx.rst                   |  2 +-
> >  doc/guides/nics/tap.rst                       |  2 +-
> >  doc/guides/nics/thunderx.rst                  |  4 +-
> >  .../prog_guide/env_abstraction_layer.rst      |  8 +--
> >  doc/guides/prog_guide/multi_proc_support.rst  |  4 +-
> >  doc/guides/prog_guide/poll_mode_drv.rst       |  6 +-
> >  .../prog_guide/switch_representation.rst      |  6 +-
> >  doc/guides/rel_notes/deprecation.rst          | 23 -------
> >  doc/guides/rel_notes/release_20_11.rst        | 11 ++++
> >  doc/guides/sample_app_ug/bbdev_app.rst        | 14 ++--
> >  .../sample_app_ug/eventdev_pipeline.rst       |  4 +-
> >  doc/guides/sample_app_ug/ipsec_secgw.rst      | 12 ++--
> >  doc/guides/sample_app_ug/l3_forward.rst       |  7 +-
> >  .../sample_app_ug/l3_forward_access_ctrl.rst  |  2 +-
> >  .../sample_app_ug/l3_forward_power_man.rst    |  3 +-
> >  doc/guides/sample_app_ug/vdpa.rst             |  2 +-
> >  doc/guides/tools/cryptoperf.rst               |  6 +-
> >  doc/guides/tools/flow-perf.rst                |  2 +-
> >  doc/guides/tools/testregex.rst                |  2 +-
> >  drivers/bus/dpaa/dpaa_bus.c                   |  7 +-
> >  drivers/bus/fslmc/fslmc_bus.c                 |  9 ++-
> >  drivers/bus/fslmc/fslmc_vfio.c                | 12 ++--
> >  drivers/bus/pci/pci_common.c                  | 24 +++----
> >  drivers/bus/vmbus/vmbus_common.c              |  4 +-
> >  drivers/crypto/virtio/virtio_pci.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    | 66 +++++++++++--------
> >  lib/librte_eal/common/eal_options.h           | 13 +++-
> >  lib/librte_eal/include/rte_bus.h              | 10 ++-
> >  lib/librte_eal/include/rte_dev.h              | 10 ++-
> >  lib/librte_eal/include/rte_devargs.h          | 10 ++-
> >  59 files changed, 326 insertions(+), 299 deletions(-)
> > 
> 
> I verified that no new build issues are introduced on various
> distro/archs combination via OBS.
> 
For v10, I think this set should be squashed down to fewer (or perhaps 1)
patch, to avoid intermediate build errors and to move the release notes
updates into the actual patches making the changes.

Thanks,
/Bruce