[v3,1/2] doc: add modify_field action description
Checks
Commit Message
This commit adds the missing modify_field action description to
`testpmd_funcs.rst`.
Signed-off-by: Suanming Mou <suanmingm@nvidia.com>
---
v3: add modify_field description.
---
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
Comments
On 10/11/2023 12:30 PM, Suanming Mou wrote:
> This commit adds the missing modify_field action description to
> `testpmd_funcs.rst`.
>
> Signed-off-by: Suanming Mou <suanmingm@nvidia.com>
>
For series,
Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
Series applied to dpdk-next-net/main, thanks.
@@ -4108,6 +4108,27 @@ This section lists supported actions and their attributes, if any.
- ``mtr_init_color {value}``: initial color value (green/yellow/red)
- ``mtr_state {unsigned}``: meter state (disabled/enabled)
+- ``modify_field``: Modify packet field
+
+ - ``op``: modify operation (set/add/sub)
+ - ``dst_type``: the destination field to be modified, the supported fields as
+ ``enum rte_flow_field_id`` listed.
+ - ``dst_level``: destination field level.
+ - ``dst_tag_index``: destination field tag array.
+ - ``dst_type_id``: destination field type ID.
+ - ``dst_class``: destination field class ID.
+ - ``dst_offset``: destination field bit offset.
+ - ``src_type``: the modify source field, the supported fields as
+ ``enum rte_flow_field_id`` listed.
+ - ``src_level``: source field level.
+ - ``src_tag_index``: source field tag array.
+ - ``src_type_id``: source field type ID.
+ - ``src_class``: source field class ID.
+ - ``src_offset``: source field bit offset.
+ - ``src_value``: source immediate value.
+ - ``src_ptr``: pointer to source immediate value.
+ - ``width``: number of bits to copy.
+
Destroying flow rules
~~~~~~~~~~~~~~~~~~~~~