doc: announce deprecation of port mirroring API

[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 c3ce3d4ee8919cebd2838d7fa07a769e806f568e..1a07f88172d7c9eda99d42530eeb5f0d4fb02035 100644 (file)
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -165,6 +165,12 @@ Deprecation Notices
   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
   APIs can be used as replacement.
 
+* ethdev: The port mirroring API can be replaced with a more fine grain flow API.
+  The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions
+  ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked
+  as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
+  This API will be fully removed in DPDK 21.11.
+
 * ethdev: Some internal APIs for driver usage are exported in the .map file.
   Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move
   them to the INTERNAL block in .map. Although these APIs are internal it will