Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options

[Thomas Monjalon <thomas@monjalon.net>]

15/11/2020 22:38, Thomas Monjalon:
> 15/11/2020 21:00, Thomas Monjalon:
> > 15/11/2020 20:58, Thomas Monjalon:
> > > 11/11/2020 11:46, Luca Boccassi:
> > > > On Tue, 2020-11-10 at 14:55 -0800, Stephen Hemminger wrote:
> > > > >  41 files changed, 178 insertions(+), 158 deletions(-)
> > > > 
> > > > Reviewed-by: Luca Boccassi <bluca@debian.org>
> > > 
> > > There are more occurences to fix:
> > > 
> > > git grep -Iw -- '-w' | wc -l
> > > 36
> > 
> > Even more (thanks David for the regex):
> > 
> > git grep -iE '(white|black)([[:space:]]|-)*list' -- ':^doc/guides/contributingcoding_style.rst' ':^doc/guides/rel_notes' doc | wc -l
> > 12
> 
> One more doc update missing: the removal of the deprecation notice.

Will add these changes:

diff --git a/devtools/test-null.sh b/devtools/test-null.sh
index fa194f01f5..4ba57a6829 100755
--- a/devtools/test-null.sh
+++ b/devtools/test-null.sh
@@ -28,5 +28,5 @@ fi
 
 (sleep 1 && echo stop) |
 $testpmd -c $coremask --no-huge -m 20 \
-       $libs -w 0:0.0 --vdev net_null1 --vdev net_null2 $eal_options -- \
+       $libs -a 0:0.0 --vdev net_null1 --vdev net_null2 $eal_options -- \
        --no-mlockall --total-num-mbufs=2048 $testpmd_options -ia
diff --git a/doc/guides/bbdevs/acc100.rst b/doc/guides/bbdevs/acc100.rst
index b77285479f..9c37bc3be1 100644
--- a/doc/guides/bbdevs/acc100.rst
+++ b/doc/guides/bbdevs/acc100.rst
@@ -241,4 +241,4 @@ Specifically for the BBDEV ACC100 PMD, the command below can be used:
 .. code-block:: console
 
   ./pf_bb_config ACC100 -c acc100/acc100_config_vf_5g.cfg
-  ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
+  ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst b/doc/guides/bbdevs/fpga_5gnr_fec.rst
index 78c1ce7978..161f5e2ae4 100644
--- a/doc/guides/bbdevs/fpga_5gnr_fec.rst
+++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst
@@ -304,4 +304,4 @@ Specifically for the BBDEV FPGA 5GNR FEC PMD, the command below can be used:
 .. code-block:: console
 
   ./pf_bb_config FPGA_5GNR -c fpga_5gnr/fpga_5gnr_config_vf.cfg
-  ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
+  ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst b/doc/guides/bbdevs/fpga_lte_fec.rst
index f0a05c928e..e268e5b9dc 100644
--- a/doc/guides/bbdevs/fpga_lte_fec.rst
+++ b/doc/guides/bbdevs/fpga_lte_fec.rst
@@ -323,4 +323,4 @@ Specifically for the BBDEV FPGA LTE FEC PMD, the command below can be used:
 .. code-block:: console
 
   ./pf_bb_config FPGA_LTE -c fpga_lte/fpga_lte_config_vf.cfg
-  ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./turbo_dec_default.data
+  ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./turbo_dec_default.data
diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
index f98c31e469..233d926e0a 100644
--- a/doc/guides/nics/dpaa2.rst
+++ b/doc/guides/nics/dpaa2.rst
@@ -514,18 +514,18 @@ For blocking a DPAA2 device, following commands can be used.
 
 Where x is the device object id as configured in resource container.
 
-Running secondary debug app without blacklist
+Running secondary debug app without blocklist
 ---------------------------------------------
 
 dpaa2 hardware imposes limits on some H/W access devices like Management
 Control Port and H/W portal. This causes issue in their shared usages in
 case of multi-process applications. It can overcome by using
-whitelist/blacklist in primary and secondary applications.
+allowlist/blocklist in primary and secondary applications.
 
 In order to ease usage of standard debugging apps like dpdk-procinfo, dpaa2
 driver reserves extra Management Control Port and H/W portal which can be
 used by debug application to debug any existing application without
-blacklisting these devices in primary process.
+blocking these devices in primary process.
 
 Limitations
 -----------
diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst
index 163ae3f47b..5d1cc9f7fa 100644
--- a/doc/guides/nics/enic.rst
+++ b/doc/guides/nics/enic.rst
@@ -180,7 +180,7 @@ 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, block the enic module as follows.
 Please see :ref:`Limitations <enic_limitations>` for limitations in
 the use of SR-IOV.
 
@@ -430,7 +430,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 blocked 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/fm10k.rst b/doc/guides/nics/fm10k.rst
index 0f7c91bbd1..7b8ef0e782 100644
--- a/doc/guides/nics/fm10k.rst
+++ b/doc/guides/nics/fm10k.rst
@@ -19,7 +19,7 @@ resource tag) information, rather than the mac and vlan table. Currently this
 feature works only on PF.
 
 To enable this feature, the user should pass a devargs parameter to the eal
-like "-w 84:00.0,enable_ftag=1", and the application should make sure an
+like "-a 84:00.0,enable_ftag=1", and the application should make sure an
 appropriate FTAG is inserted for every frame on TX side.
 
 Vector PMD for FM10K
diff --git a/doc/guides/prog_guide/compressdev.rst b/doc/guides/prog_guide/compressdev.rst
index a089db1fad..231687d891 100644
--- a/doc/guides/prog_guide/compressdev.rst
+++ b/doc/guides/prog_guide/compressdev.rst
@@ -19,7 +19,7 @@ Physical compression devices are discovered during the bus probe of the EAL func
 which is executed at DPDK initialization, based on their unique device identifier.
 For e.g. PCI devices can be identified using PCI BDF (bus/bridge, device, function).
 Specific physical compression devices, like other physical devices in DPDK can be
-white-listed or black-listed using the EAL command line options.
+listed using the EAL command line options.
 
 Virtual devices can be created by two mechanisms, either using the EAL command
 line options or from within the application using an EAL API directly.
diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst
index 72129e4b70..473b014a10 100644
--- a/doc/guides/prog_guide/cryptodev_lib.rst
+++ b/doc/guides/prog_guide/cryptodev_lib.rst
@@ -32,7 +32,7 @@ Physical Crypto devices are discovered during the PCI probe/enumeration of the
 EAL function which is executed at DPDK initialization, based on
 their PCI device identifier, each unique PCI BDF (bus/bridge, device,
 function). Specific physical Crypto devices, like other physical devices in DPDK
-can be white-listed or black-listed using the EAL command line options.
+can be listed using the EAL command line options.
 
 Virtual devices can be created by two mechanisms, either using the EAL command
 line options or from within the application using an EAL API directly.
diff --git a/doc/guides/prog_guide/regexdev.rst b/doc/guides/prog_guide/regexdev.rst
index 0d84fb1a19..3d8b591b56 100644
--- a/doc/guides/prog_guide/regexdev.rst
+++ b/doc/guides/prog_guide/regexdev.rst
@@ -30,7 +30,7 @@ Physical RegEx devices are discovered during the PCI probe/enumeration of the
 EAL function which is executed at DPDK initialization, based on
 their PCI device identifier, each unique PCI BDF (bus/bridge, device,
 function). Specific physical ReEx devices, like other physical devices in DPDK
-can be white-listed or black-listed using the EAL command line options.
+can be listed using the EAL command line options.
 
 
 Device Identification
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 8eac073591..96986fabd5 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -28,17 +28,6 @@ Deprecation Notices
 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
   for returning key match count. It will ease handling of no-match case.
 
-* eal: The terms blacklist and whitelist to describe devices used
-  by DPDK will be replaced in the 20.11 relase.
-  This will apply to command line arguments.
-
-  The command line arguments to ``rte_eal_init`` will change from
-  ``-b, --pci-blacklist`` to ``-x, --exclude`` and
-  ``-w, --pci-whitelist`` to ``-i, --include``.
-  The old command line arguments will continue to be accepted in 20.11
-  but will cause a runtime warning message. The old arguments will
-  be removed in a future release.
-
 * eal: The function ``rte_eal_remote_launch`` will return new error codes
   after read or write error on the pipe, instead of calling ``rte_panic``.
 
diff --git a/doc/guides/sample_app_ug/bbdev_app.rst b/doc/guides/sample_app_ug/bbdev_app.rst
index b2af9a0755..45e69e36e2 100644
--- a/doc/guides/sample_app_ug/bbdev_app.rst
+++ b/doc/guides/sample_app_ug/bbdev_app.rst
@@ -106,7 +106,7 @@ where:
 * ``-c COREMASK``: A hexadecimal bitmask of cores to run on
 * ``--socket-mem``: Memory to allocate on specific sockets (use comma separated values)
 * ``--file-prefix``: Prefix for hugepage filenames
-* ``-a <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>.
+* ``-a <NIC1PCIADDR>``: Add a PCI device in allow list. The argument format is <[domain:]bus:devid.func>.
 * ``-m <string>``: Matrix for mapping ports to logical cores.
 * ``-P``: PROMISCUOUS mode
 
diff --git a/doc/guides/tools/comp_perf.rst b/doc/guides/tools/comp_perf.rst
index 6ba1076484..9d2f4dbe4a 100644
--- a/doc/guides/tools/comp_perf.rst
+++ b/doc/guides/tools/comp_perf.rst
@@ -53,9 +53,9 @@ See the DPDK Getting Started Guides for more information on these options.
        One lcore is needed for process admin, tests are run on all other cores.
        To run tests on two lcores, three lcores must be passed to the tool.
 
-*   ``-w <PCI>``
+*   ``-a <PCI>``
 
-       Add a PCI device in white list.
+       Add a PCI device in allow list.
 
 *   ``--vdev <driver><id>``
 
diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst
index 73cabf0098..79359fe894 100644
--- a/doc/guides/tools/cryptoperf.rst
+++ b/doc/guides/tools/cryptoperf.rst
@@ -65,9 +65,9 @@ See the DPDK Getting Started Guides for more information on these options.
         Set the hexadecimal bitmask of the cores to run on. The corelist is a
         list cores to use.
 
-*   ``-w <PCI>``
+*   ``-a <PCI>``
 
-        Add a PCI device in white list.
+        Add a PCI device in allow list.
 
 *   ``--vdev <driver><id>``
 
diff --git a/drivers/bus/vmbus/vmbus_common.c b/drivers/bus/vmbus/vmbus_common.c
index b31678ad05..39b3308577 100644
--- a/drivers/bus/vmbus/vmbus_common.c
+++ b/drivers/bus/vmbus/vmbus_common.c
@@ -206,7 +206,7 @@ vmbus_parse(const char *name, void *addr)
 /*
  * scan for matching device args on command line
  * example:
- *     -w 'vmbus:635a7ae3-091e-4410-ad59-667c4f8c04c3,latency=20'
+ *     -a 'vmbus:635a7ae3-091e-4410-ad59-667c4f8c04c3,latency=20'
  */
 struct rte_devargs *
 vmbus_devargs_lookup(struct rte_vmbus_device *dev)
diff --git a/drivers/net/bnxt/bnxt_ethdev.c b/drivers/net/bnxt/bnxt_ethdev.c
index 31153518ce..81c8f8d79d 100644
--- a/drivers/net/bnxt/bnxt_ethdev.c
+++ b/drivers/net/bnxt/bnxt_ethdev.c
@@ -5151,21 +5151,21 @@ bnxt_parse_dev_args(struct bnxt *bp, struct rte_devargs *devargs)
 
        /*
         * Handler for "truflow" devarg.
-        * Invoked as for ex: "-w 0000:00:0d.0,host-based-truflow=1"
+        * Invoked as for ex: "-a 0000:00:0d.0,host-based-truflow=1"
         */
        rte_kvargs_process(kvlist, BNXT_DEVARG_TRUFLOW,
                           bnxt_parse_devarg_truflow, bp);
 
        /*
         * Handler for "flow_xstat" devarg.
-        * Invoked as for ex: "-w 0000:00:0d.0,flow_xstat=1"
+        * Invoked as for ex: "-a 0000:00:0d.0,flow_xstat=1"
         */
        rte_kvargs_process(kvlist, BNXT_DEVARG_FLOW_XSTAT,
                           bnxt_parse_devarg_flow_xstat, bp);
 
        /*
         * Handler for "max_num_kflows" devarg.
-        * Invoked as for ex: "-w 000:00:0d.0,max_num_kflows=32"
+        * Invoked as for ex: "-a 000:00:0d.0,max_num_kflows=32"
         */
        rte_kvargs_process(kvlist, BNXT_DEVARG_MAX_NUM_KFLOWS,
                           bnxt_parse_devarg_max_num_kflows, bp);
@@ -5569,7 +5569,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev,
                if (kvlist) {
                        /*
                         * Handler for "rep_is_pf" devarg.
-                        * Invoked as for ex: "-w 000:00:0d.0,
+                        * Invoked as for ex: "-a 000:00:0d.0,
                         * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>"
                         */
                        ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_IS_PF,
@@ -5581,7 +5581,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev,
                        }
                        /*
                         * Handler for "rep_based_pf" devarg.
-                        * Invoked as for ex: "-w 000:00:0d.0,
+                        * Invoked as for ex: "-a 000:00:0d.0,
                         * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>"
                         */
                        ret = rte_kvargs_process(kvlist,
@@ -5594,7 +5594,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev,
                        }
                        /*
                         * Handler for "rep_based_pf" devarg.
-                        * Invoked as for ex: "-w 000:00:0d.0,
+                        * Invoked as for ex: "-a 000:00:0d.0,
                         * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>"
                         */
                        ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_Q_R2F,
@@ -5606,7 +5606,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev,
                        }
                        /*
                         * Handler for "rep_based_pf" devarg.
-                        * Invoked as for ex: "-w 000:00:0d.0,
+                        * Invoked as for ex: "-a 000:00:0d.0,
                         * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>"
                         */
                        ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_Q_F2R,
@@ -5618,7 +5618,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev,
                        }
                        /*
                         * Handler for "rep_based_pf" devarg.
-                        * Invoked as for ex: "-w 000:00:0d.0,
+                        * Invoked as for ex: "-a 000:00:0d.0,
                         * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>"
                         */
                        ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_FC_R2F,
@@ -5630,7 +5630,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev,
                        }
                        /*
                         * Handler for "rep_based_pf" devarg.
-                        * Invoked as for ex: "-w 000:00:0d.0,
+                        * Invoked as for ex: "-a 000:00:0d.0,
                         * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>"
                         */
                        ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_FC_F2R,
diff --git a/examples/ipsec-secgw/test/linux_test.sh b/examples/ipsec-secgw/test/linux_test.sh
index 85dbf7e8a8..8f31154f8d 100644
--- a/examples/ipsec-secgw/test/linux_test.sh
+++ b/examples/ipsec-secgw/test/linux_test.sh
@@ -14,7 +14,7 @@
 #  SGW_PATH    - path to the ipsec-secgw binary to test
 #  REMOTE_HOST - ip/hostname of the DUT
 #  REMOTE_IFACE        - iface name for the test-port on DUT
-#  ETH_DEV     - ethernet device to be used on SUT by DPDK ('-w <pci-id>')
+#  ETH_DEV     - ethernet device to be used on SUT by DPDK ('-a <pci-id>')
 # Also user can optionally setup:
 #  SGW_LCORE   - lcore to run ipsec-secgw on (default value is 0)
 #  SGW_MODE    - run ipsec-secgw in legacy mode or with use of library
@@ -29,7 +29,7 @@
 #              values: cpu-crypto/lookaside-none (unset on default)
 #  CRYPTO_PRIM_TYPE - run ipsec-secgw with crypto primary type set
 #              values: cpu-crypto (unset on default)
-#  CRYPTO_DEV - crypto device to be used ('-w <pci-id>')
+#  CRYPTO_DEV - crypto device to be used ('-a <pci-id>')
 #             if none specified appropriate vdevs will be created by the script
 #  SGW_MULTI_SEG - ipsec-secgw option to enable reassembly support and
 #              specify size of reassembly table (i.e. SGW_MULTI_SEG=128)
diff --git a/examples/ipsec-secgw/test/run_test.sh b/examples/ipsec-secgw/test/run_test.sh
index 1222308bbe..a91dade4fe 100755
--- a/examples/ipsec-secgw/test/run_test.sh
+++ b/examples/ipsec-secgw/test/run_test.sh
@@ -8,10 +8,10 @@
 #  SGW_PATH    - path to the ipsec-secgw binary to test
 #  REMOTE_HOST - ip/hostname of the DUT
 #  REMOTE_IFACE        - iface name for the test-port on DUT
-#  ETH_DEV     - ethernet device to be used on SUT by DPDK ('-w <pci-id>')
+#  ETH_DEV     - ethernet device to be used on SUT by DPDK ('-a <pci-id>')
 # Also user can optionally setup:
 #  SGW_LCORE   - lcore to run ipsec-secgw on (default value is 0)
-#  CRYPTO_DEV  - crypto device to be used ('-w <pci-id>')
+#  CRYPTO_DEV  - crypto device to be used ('-a <pci-id>')
 #             if none specified appropriate vdevs will be created by the script
 #  SGW_MULTI_SEG - ipsec-secgw option to enable reassembly support and
 #              specify size of reassembly table (i.e. SGW_MULTI_SEG=128)