diff mbox series

[1/2] doc: more info of rte flow shared action

Message ID 9b8375c7ce4991e771a8734e9759fd2aed811c65.1612266977.git.jackmin@nvidia.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series doc update for rte flow shared action |

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Jack Min Feb. 2, 2021, 12:23 p.m. UTC 
  Added more information of shared action on
how to update, query, and the benefits.

Signed-off-by: Xiaoyu Min <jackmin@nvidia.com>
---
 doc/guides/prog_guide/rte_flow.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Ori Kam Feb. 3, 2021, 7:50 a.m. UTC | #1 
Hi Jack,

> -----Original Message-----
> From: Jack Min <jackmin@nvidia.com>
> Subject: [PATCH 1/2] doc: more info of rte 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>
> ---
>  doc/guides/prog_guide/rte_flow.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/rte_flow.rst
> b/doc/guides/prog_guide/rte_flow.rst
> index 0b8c243fe1..62a57919eb 100644
> --- 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
> --
> 2.30.0

Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori
Asaf Penso Feb. 3, 2021, 9:02 a.m. UTC | #2 
Hi Jack,

>-----Original Message-----
>From: dev <dev-bounces@dpdk.org> On Behalf Of Ori Kam
>Sent: Wednesday, February 3, 2021 9:51 AM
>To: Jack Min <jackmin@nvidia.com>
>Cc: dev@dpdk.org
>Subject: Re: [dpdk-dev] [PATCH 1/2] doc: more info of rte flow shared action
>
>Hi Jack,
>
>> -----Original Message-----
>> From: Jack Min <jackmin@nvidia.com>
>> Subject: [PATCH 1/2] doc: more info of rte 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>
>> ---
>>  doc/guides/prog_guide/rte_flow.rst | 7 +++++++
>>  1 file changed, 7 insertions(+)
>>
>> diff --git a/doc/guides/prog_guide/rte_flow.rst
>> b/doc/guides/prog_guide/rte_flow.rst
>> index 0b8c243fe1..62a57919eb 100644
>> --- 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
>> --
>> 2.30.0
>
>Acked-by: Ori Kam <orika@nvidia.com>
>Best,
>Ori

Reviewed-by: Asaf Penso <asafp@nvidia.com>
Ferruh Yigit Feb. 3, 2021, 11:58 a.m. UTC | #3 
On 2/3/2021 9:02 AM, Asaf Penso wrote:
> Hi Jack,
> 
>> -----Original Message-----
>> From: dev <dev-bounces@dpdk.org> On Behalf Of Ori Kam
>> Sent: Wednesday, February 3, 2021 9:51 AM
>> To: Jack Min <jackmin@nvidia.com>
>> Cc: dev@dpdk.org
>> Subject: Re: [dpdk-dev] [PATCH 1/2] doc: more info of rte flow shared action
>>
>> Hi Jack,
>>
>>> -----Original Message-----
>>> From: Jack Min <jackmin@nvidia.com>
>>> Subject: [PATCH 1/2] doc: more info of rte 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>
>> Best,
>> Ori
> 
> Reviewed-by: Asaf Penso <asafp@nvidia.com>
> 

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index 0b8c243fe1..62a57919eb 100644
--- 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