[dpdk-dev] [PATCH v2] doc: announce ABI change of rte_eth_fdir_filter, rte_eth_fdir_masks

[Wenzhuo Lu]

For x550 supports 2 new flow director modes, MAC VLAN and Cloud. The MAC VLAN
mode means the MAC and VLAN are monitored. The Cloud mode is for VxLAN and
NVGRE, and the tunnel type, TNI/VNI, inner MAC and inner VLAN are monitored. So,
there're a few new lookup fields for these 2 new modes, like MAC, tunnel type,
TNI/VNI. We have to change the ABI to support these new lookup fields.

v2 changes:
* Correct the names of the structures.
* Wrap the words.
* Add explanation for the new modes.

Signed-off-by: Wenzhuo Lu <wenzhuo.lu at intel.com>
---
 doc/guides/rel_notes/abi.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/guides/rel_notes/abi.rst b/doc/guides/rel_notes/abi.rst
index 110c486..37bcad9 100644
--- a/doc/guides/rel_notes/abi.rst
+++ b/doc/guides/rel_notes/abi.rst
@@ -12,3 +12,13 @@ Examples of Deprecation Notices
 
 Deprecation Notices
 -------------------
+* The ABI changes are planned for struct rte_eth_fdir_filter and
+  rte_eth_fdir_masks in order to support new flow director modes,
+  MAC VLAN and Cloud, on x550. The MAC VLAN mode means the MAC and
+  VLAN are monitored. The Cloud mode is for VxLAN and NVGRE, and
+  the tunnel type, TNI/VNI, inner MAC and inner VLAN are monitored.
+  The upcoming release 2.1 will not contain these ABI changes, but
+  release 2.2 will, and no backwards compatibility is planed due to
+  this change.
+  Binaries using this library build prior to version 2.2 will require
+  updating and recompilation.
-- 
1.9.3