The modify field action description inside "Generic flow API (rte_flow)"
documentation, lists all operations supported for a destination field.
In addition, it lists the values supported for a encapsulation level
field.
Before the lists, in both cases, miss a blank line causing them to look
regular text lines.
This patch adds the blank lines.
Fixes: 73b68f4c54a0 ("ethdev: introduce generic modify flow action")
Cc: akozy...@nvidia.com
Cc: sta...@dpdk.org
Signed-off-by: Michael Baum <michae...@nvidia.com>
---
doc/guides/prog_guide/rte_flow.rst | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/doc/guides/prog_guide/rte_flow.rst
b/doc/guides/prog_guide/rte_flow.rst
index 32fc45516a..e7faa368a1 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -2917,20 +2917,23 @@ The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a
pointer to it
``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.
+``op`` selects the operation to perform on a destination field:
+
- ``set`` copies the data from ``src`` field to ``dst`` field.
- ``add`` adds together ``dst`` and ``src`` and stores the result into ``dst``.
-- ``sub`` subtracts ``src`` from ``dst`` and stores the result into ``dst``
+- ``sub`` subtracts ``src`` from ``dst`` and stores the result into ``dst``.
``width`` defines a number of bits to use from ``src`` field.
``level`` is used to access any packet field on any encapsulation level
-as well as any tag element in the tag array.
-- ``0`` means the default behaviour. Depending on the packet type, it can
-mean outermost, innermost or anything in between.
+as well as any tag element in the tag array:
+
+- ``0`` means the default behaviour. Depending on the packet type,
+ it can mean outermost, innermost or anything in between.
- ``1`` requests access to the outermost packet encapsulation level.
- ``2`` and subsequent values requests access to the specified packet
-encapsulation level, from outermost to innermost (lower to higher values).
+ encapsulation level, from outermost to innermost (lower to higher values).
+
For the tag array (in case of multiple tags are supported and present)
``level`` translates directly into the array index.
--
2.25.1
