patch 'doc: fix format in flow API guide' has been queued to stable release 22.11.3

[Xueming Li]

Hi,

FYI, your patch has been queued to stable release 22.11.3

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 06/27/23. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://git.dpdk.org/dpdk-stable/log/?h=22.11-staging

This queued commit can be viewed at:
https://git.dpdk.org/dpdk-stable/commit/?h=22.11-staging&id=bdf2131156d22ccf14856b62fac283ad86cf3af6

Thanks.

Xueming Li <xuemingl at nvidia.com>

---
>From bdf2131156d22ccf14856b62fac283ad86cf3af6 Mon Sep 17 00:00:00 2001
From: Michael Baum <michaelba at nvidia.com>
Date: Wed, 24 May 2023 00:31:53 +0300
Subject: [PATCH] doc: fix format in flow API guide
Cc: Xueming Li <xuemingl at nvidia.com>

[ upstream commit 5d254667810fffe59190ca208a078bcb666a2a71 ]

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.

The asynchronous operations description inside "Generic flow API
(rte_flow)" documentation, adds some bullets to describe asynchronous
operations behavior.
Before the first bullet, miss a blank line causing it to look a regular
text line.
This patch adds the blank line.

The RSS action description inside "Generic flow API (rte_flow)"
documentation, lists the values supported for a encapsulation level
field.
For "2" value, it uses 3 spaces as an indentation instead of 2 after
line breaking, causing the first line to be bold.
This patch updates the number of spaces in the indentation.

Fixes: 73b68f4c54a0 ("ethdev: introduce generic modify flow action")
Fixes: 197e820c6685 ("ethdev: bring in async queue-based flow rules operations")
Fixes: 18aee2861a1f ("ethdev: add encap level to RSS flow API action")

Signed-off-by: Michael Baum <michaelba at nvidia.com>
Acked-by: Ori Kam <orika at nvidia.com>
---
 doc/guides/prog_guide/rte_flow.rst | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index 40d3f5bd44..e98f1fdd52 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -1918,8 +1918,8 @@ Also, regarding packet encapsulation ``level``:
   level.
 
 - ``2`` and subsequent values request RSS to be performed on the specified
-   inner packet encapsulation level, from outermost to innermost (lower to
-   higher values).
+  inner packet encapsulation level, from outermost to innermost (lower to
+  higher values).
 
 Values other than ``0`` are not necessarily supported.
 
@@ -2881,20 +2881,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.
 
@@ -3602,6 +3605,7 @@ Asynchronous operations
 -----------------------
 
 Flow rules management can be done via special lockless flow management queues.
+
 - Queue operations are asynchronous and not thread-safe.
 
 - Operations can thus be invoked by the app's datapath,
-- 
2.25.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2023-06-25 14:31:59.773420200 +0800
+++ 0047-doc-fix-format-in-flow-API-guide.patch	2023-06-25 14:31:58.365773900 +0800
@@ -1 +1 @@
-From 5d254667810fffe59190ca208a078bcb666a2a71 Mon Sep 17 00:00:00 2001
+From bdf2131156d22ccf14856b62fac283ad86cf3af6 Mon Sep 17 00:00:00 2001
@@ -4,0 +5,3 @@
+Cc: Xueming Li <xuemingl at nvidia.com>
+
+[ upstream commit 5d254667810fffe59190ca208a078bcb666a2a71 ]
@@ -31 +33,0 @@
-Cc: stable at dpdk.org
@@ -40 +42 @@
-index 27fa3dd304..7116c9ce23 100644
+index 40d3f5bd44..e98f1fdd52 100644
@@ -43 +45 @@
-@@ -1968,8 +1968,8 @@ Also, regarding packet encapsulation ``level``:
+@@ -1918,8 +1918,8 @@ Also, regarding packet encapsulation ``level``:
@@ -54 +56 @@
-@@ -3049,20 +3049,23 @@ The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it
+@@ -2881,20 +2881,23 @@ The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it
@@ -84 +86 @@
-@@ -3856,6 +3859,7 @@ Asynchronous operations
+@@ -3602,6 +3605,7 @@ Asynchronous operations