[20.08,4/6] doc: announce deprecation blacklist/whitelist

Message ID 20200727192015.26418-5-stephen@networkplumber.org (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series Inclusive language fixes and deprecation notices |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK

Commit Message

Stephen Hemminger July 27, 2020, 7:20 p.m. UTC
  Announce upcoming changes for 20.11 around the terms blacklist
and whitelist.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/rel_notes/deprecation.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 31a2b942fba5..b022a9f91ece 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -165,3 +165,19 @@  Deprecation Notices
 
   The ``master-lcore`` argument to testpmd will be replaced
   with ``initial-lcore``.
+
+* eal: The terms blacklist and whitelist to describe devices used
+  by DPDK will be replaced by blocked and allowed in the 20.11 relase.
+  This will apply to command line arguments and macros.
+
+  The macros ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_BLOCKED``
+  and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_ALLOWED``
+
+  The old macros will be marked as deprecated in 20.11 and removed
+  in the 21.11 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 error message.