From 714e3e60014206cb616cd4157bf11a5209e7186f Mon Sep 17 00:00:00 2001 From: Stephen Hemminger Date: Thu, 6 Aug 2020 10:19:45 -0700 Subject: [PATCH] doc: announce deprecation of blacklist/whitelist naming Announce upcoming changes for 20.11. Signed-off-by: Stephen Hemminger Acked-by: Bruce Richardson Acked-by: John McNamara --- doc/guides/rel_notes/deprecation.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 4fca4ba524..fb3547a4e2 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -46,6 +46,29 @@ Deprecation Notices will produce a runtime notification in 20.11 release, and be removed completely in a future release. +* 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``. -- 2.20.1