diff mbox series

doc: refer to the supported Field IDs for modify field API

Message ID 20210331160028.21811-1-akozyrev@nvidia.com (mailing list archive)
State Superseded
Delegated to: Ferruh Yigit
Headers show
Series doc: refer to the supported Field IDs for modify field API | expand

Checks

Context Check Description
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/github-robot success github build: passed
ci/travis-robot success travis build: passed
ci/checkpatch success coding style OK

Commit Message

Alexander Kozyrev March 31, 2021, 4 p.m. UTC
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(-)

Comments

Ferruh Yigit April 8, 2021, 7:54 a.m. UTC | #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               |
>      +---------------+----------------------------------------------------------+
>   
>
diff mbox series

Patch

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               |
    +---------------+----------------------------------------------------------+