Include the rte_flow_field_id enumeration reference into the documentation to point to the full list of all supported Field IDs available for the MODIFY_FIELD RTE action. Signed-off-by: Alexander Kozyrev <akozyrev@nvidia.com> Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com> --- doc/guides/prog_guide/rte_flow.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index a1fdcd7c07..9fce58ea5e 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2777,6 +2777,7 @@ can be used as both source and destination fields as set by ``field``. The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it ``RTE_FLOW_FIELD_POINTER``) is allowed as a source only. ``RTE_FLOW_FIELD_START`` is used to point to the beginning of a packet. +See ``enum rte_flow_field_id`` for the list of supported fields. ``op`` selects the operation to perform on a destination field. - ``set`` copies the data from ``src`` field to ``dst`` field. @@ -2810,12 +2811,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively. .. table:: MODIFY_FIELD - +-----------------------------------------+ + +---------------+-------------------------+ | Field | Value | +===============+=========================+ | ``op`` | operation to perform | + +---------------+-------------------------+ | ``dst`` | destination field | + +---------------+-------------------------+ | ``src`` | source field | + +---------------+-------------------------+ | ``width`` | number of bits to use | +---------------+-------------------------+ @@ -2823,12 +2827,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively. .. table:: destination/source field definition - +--------------------------------------------------------------------------+ + +---------------+----------------------------------------------------------+ | Field | Value | +===============+==========================================================+ | ``field`` | ID: packet field, mark, meta, tag, immediate, pointer | + +---------------+----------------------------------------------------------+ | ``level`` | encapsulation level of a packet field or tag array index | + +---------------+----------------------------------------------------------+ | ``offset`` | number of bits to skip at the beginning | + +---------------+----------------------------------------------------------+ | ``value`` | immediate value or a pointer to this value | +---------------+----------------------------------------------------------+ -- 2.24.1
On 3/31/2021 5:00 PM, Alexander Kozyrev wrote: > Include the rte_flow_field_id enumeration reference into > the documentation to point to the full list of all supported > Field IDs available for the MODIFY_FIELD RTE action. > This patch also fixes formatting of the tables, can you please mention from it in the commit log and add the fixes line for it? > Signed-off-by: Alexander Kozyrev <akozyrev@nvidia.com> > Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com> > --- > doc/guides/prog_guide/rte_flow.rst | 11 +++++++++-- > 1 file changed, 9 insertions(+), 2 deletions(-) > > diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst > index a1fdcd7c07..9fce58ea5e 100644 > --- a/doc/guides/prog_guide/rte_flow.rst > +++ b/doc/guides/prog_guide/rte_flow.rst > @@ -2777,6 +2777,7 @@ can be used as both source and destination fields as set by ``field``. > The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it > ``RTE_FLOW_FIELD_POINTER``) is allowed as a source only. > ``RTE_FLOW_FIELD_START`` is used to point to the beginning of a packet. > +See ``enum rte_flow_field_id`` for the list of supported fields. > > ``op`` selects the operation to perform on a destination field. > - ``set`` copies the data from ``src`` field to ``dst`` field. > @@ -2810,12 +2811,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively. > > .. table:: MODIFY_FIELD > > - +-----------------------------------------+ > + +---------------+-------------------------+ > | Field | Value | > +===============+=========================+ > | ``op`` | operation to perform | > + +---------------+-------------------------+ > | ``dst`` | destination field | > + +---------------+-------------------------+ > | ``src`` | source field | > + +---------------+-------------------------+ > | ``width`` | number of bits to use | > +---------------+-------------------------+ > > @@ -2823,12 +2827,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively. > > .. table:: destination/source field definition > > - +--------------------------------------------------------------------------+ > + +---------------+----------------------------------------------------------+ > | Field | Value | > +===============+==========================================================+ > | ``field`` | ID: packet field, mark, meta, tag, immediate, pointer | > + +---------------+----------------------------------------------------------+ > | ``level`` | encapsulation level of a packet field or tag array index | > + +---------------+----------------------------------------------------------+ > | ``offset`` | number of bits to skip at the beginning | > + +---------------+----------------------------------------------------------+ > | ``value`` | immediate value or a pointer to this value | > +---------------+----------------------------------------------------------+ > >
Fix the documentation about the MODIFY_FIELD RTE Flow action. 1. Include the rte_flow_field_id enumeration reference to point to the full list of all supported Field IDs available. 2. Correct the formatting of the MODIFY_FIELD action and the destination/source field definition tables. Fixes: 73b68f4c54 ("ethdev: introduce generic modify flow action") Cc: stable@dpdk.org Signed-off-by: Alexander Kozyrev <akozyrev@nvidia.com> Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com> --- v2: added commit message about the tables formatting doc/guides/prog_guide/rte_flow.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index aec2ba1ec0..e1b93ecedf 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2779,6 +2779,7 @@ can be used as both source and destination fields as set by ``field``. The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it ``RTE_FLOW_FIELD_POINTER``) is allowed as a source only. ``RTE_FLOW_FIELD_START`` is used to point to the beginning of a packet. +See ``enum rte_flow_field_id`` for the list of supported fields. ``op`` selects the operation to perform on a destination field. - ``set`` copies the data from ``src`` field to ``dst`` field. @@ -2812,12 +2813,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively. .. table:: MODIFY_FIELD - +-----------------------------------------+ + +---------------+-------------------------+ | Field | Value | +===============+=========================+ | ``op`` | operation to perform | + +---------------+-------------------------+ | ``dst`` | destination field | + +---------------+-------------------------+ | ``src`` | source field | + +---------------+-------------------------+ | ``width`` | number of bits to use | +---------------+-------------------------+ @@ -2825,12 +2829,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively. .. table:: destination/source field definition - +--------------------------------------------------------------------------+ + +---------------+----------------------------------------------------------+ | Field | Value | +===============+==========================================================+ | ``field`` | ID: packet field, mark, meta, tag, immediate, pointer | + +---------------+----------------------------------------------------------+ | ``level`` | encapsulation level of a packet field or tag array index | + +---------------+----------------------------------------------------------+ | ``offset`` | number of bits to skip at the beginning | + +---------------+----------------------------------------------------------+ | ``value`` | immediate value or a pointer to this value | +---------------+----------------------------------------------------------+ -- 2.24.1
On 4/8/2021 1:32 PM, Alexander Kozyrev wrote:
> Fix the documentation about the MODIFY_FIELD RTE Flow action.
> 1. Include the rte_flow_field_id enumeration reference to point
> to the full list of all supported Field IDs available.
> 2. Correct the formatting of the MODIFY_FIELD action and the
> destination/source field definition tables.
>
> Fixes: 73b68f4c54 ("ethdev: introduce generic modify flow action")
> Cc: stable@dpdk.org
>
> Signed-off-by: Alexander Kozyrev <akozyrev@nvidia.com>
> Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Applied to dpdk-next-net/main, thanks.