doc: add more explanation about flow shared action

Added more information of shared action on
how to update, query, and the benefits.

Signed-off-by: Xiaoyu Min <jackmin@nvidia.com>
Acked-by: Ori Kam <orika@nvidia.com>
Reviewed-by: Asaf Penso <asafp@nvidia.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index 0b8c243..62a5791 100644 (file)
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -2756,6 +2756,13 @@ Flow utilize shared action by handle as returned from
 The behaviour of the shared action defined by ``action`` argument of type
 ``struct rte_flow_action`` passed to ``rte_flow_shared_action_create()``.
 
+Multiple flows can use the same shared action.
+The shared action can be in-place updated by ``rte_flow_shared_action_update()``
+without destroying flow and creating flow again.
+
+The shared action specified data (e.g. counter) can be queried by
+``rte_flow_shared_action_query()``.
+
 .. _table_rte_flow_shared_action:
 
 .. table:: SHARED