Re: [dpdk-dev] [PATCH v9 6/6] doc: update release notes now for block allow changes

[Bruce Richardson <bruce.richardson@intel.com>]

On Thu, Nov 05, 2020 at 02:36:02PM -0800, Stephen Hemminger wrote:
> Remove the deprecation notice and add description to the release notes.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
>  doc/guides/rel_notes/deprecation.rst   | 23 -----------------------
>  doc/guides/rel_notes/release_20_11.rst | 11 +++++++++++
>  2 files changed, 11 insertions(+), 23 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index f3258eb3f725..d459a25eabe3 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -28,29 +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 as well as macros.
> -
> -  The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED``
> -  and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED``
> -  ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be
> -  replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED``
> -  respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and
> -  ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with
> -  ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``.
> -
> -  The old macros will be marked as deprecated in 20.11 and any
> -  usage will cause a compile warning. They will be removed in
> -  a future release.
> -
> -  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/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst
> index 6bbd6ee93922..df955e2214c4 100644
> --- a/doc/guides/rel_notes/release_20_11.rst
> +++ b/doc/guides/rel_notes/release_20_11.rst
> @@ -644,6 +644,17 @@ API Changes
>  * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
>    from ``struct rte_sched_subport_params``.
>  
> +* eal: The selection of devices on the EAL command line has been
> +  changed from ``--pci-blacklist`` and ``--pci-whitelist``
> +  to ``--block`` and ``--allow``. The short form option for
> +  using a device is now ``-a`` instead of ``-w``.
> +
> +  The internal macros for ``RTE_DEV_BLACKLISTED`` and ``RTE_DEV_WHITELISTED``
> +  have been replaced with ``RTE_DEV_BLOCKED`` and ``RTE_DEV_ALLOWED``.
> +
> +  There are compatibility macros and command line mappings to accept
> +  the old values but applications and scripts are strongly encouraged
> +  to migrate to the new names.
>  

Are all the other macro changes non-user visible? Do they need to be called
out somewhere, or is the above enough?

/Bruce