[dpdk-dev] [PATCH v1 2/4] doc: announce API change for flow RSS action

[Adrien Mazarguil]

Since its inception, the rte_flow RSS action has been relying in part on
struct rte_eth_rss_conf for compatibility with the legacy RSS API. This
structure lacks parameters such as the hash function to use, and more
recently, a method to tell which layer RSS should be performed on [1].

Given struct rte_eth_rss_conf will never be flexible enough to represent a
complete RSS configuration (e.g. RETA table), struct rte_flow_action_rss
will be extended instead.

Depending on the outcome of RSS level implementation work, this deprecation
notice may either cancel or come in conjunction with [1].

[1] http://dpdk.org/ml/archives/dev/2018-February/090359.html

Signed-off-by: Adrien Mazarguil <adrien.mazarguil at 6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 663550acb..40b76b391 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -67,3 +67,8 @@ Deprecation Notices
   (non-)terminating property of actions will be discarded. Instead, flow
   rules themselves will be considered terminating by default unless a
   PASSTHRU action is also specified.
+
+* rte_flow: RSS action will stop relying on the legacy ``struct
+  rte_eth_rss_conf`` due to its limitations. All parameters, including the
+  currently missing hash function to use will be made part of ``struct
+  rte_flow_action_rss`` directly.
-- 
2.11.0