doc: announce deprecation of blacklist/whitelist naming

[dpdk.git] / doc / guides / rel_notes / deprecation.rst

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4fca4ba..fb3547a 100644 (file)
--- 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``.