patch 'doc: fix some ordered lists' has been queued to stable release 20.11.10

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 20.11.10

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/01/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://github.com/bluca/dpdk-stable

This queued commit can be viewed at:
https://github.com/bluca/dpdk-stable/commit/11b2f328f49fb7abc4b0e39f275d301af5fe4696

Thanks.

Luca Boccassi

---
>From 11b2f328f49fb7abc4b0e39f275d301af5fe4696 Mon Sep 17 00:00:00 2001
From: David Marchand <david.marchand at redhat.com>
Date: Fri, 10 Nov 2023 11:15:05 +0100
Subject: [PATCH] doc: fix some ordered lists

[ upstream commit fc7428ead4ee6e1239ccd0bd4065edd974549ad6 ]

Ordered lists must start preceded by an empty line.
Entries must be separated by an empty line (as per our coding style).
Incorrectly indented lines are seen as a separator and result in
starting a new list in the rendered doc.

Fix issues in some guides.

Fixes: 26b683b4f7d0 ("net/virtio: setup Rx queue interrupts")
Fixes: 9dcf5d15569b ("doc: clarify path selection in virtio guide")
Fixes: 68a03efeed65 ("doc: add Marvell cnxk platform guide")
Fixes: f6010c7655cc ("doc: add GSO programmer's guide")

Signed-off-by: David Marchand <david.marchand at redhat.com>
Acked-by: Bruce Richardson <bruce.richardson at intel.com>
---
 doc/guides/nics/virtio.rst                           | 12 ++++++++++++
 doc/guides/platform/octeontx2.rst                    |  3 +++
 .../prog_guide/generic_segmentation_offload_lib.rst  |  2 +-
 3 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 30a99be534..1922e1b444 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -301,6 +301,7 @@ Prerequisites for Rx interrupts
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To support Rx interrupts,
+
 #. Check if guest kernel supports VFIO-NOIOMMU:
 
     Linux started to support VFIO-NOIOMMU since 4.8.0. Make sure the guest
@@ -463,12 +464,16 @@ according to below configuration:
 
 #. Split virtqueue mergeable path: If Rx mergeable is negotiated, in-order feature is
    not negotiated, this path will be selected.
+
 #. Split virtqueue non-mergeable path: If Rx mergeable and in-order feature are not
    negotiated, also Rx offload(s) are requested, this path will be selected.
+
 #. Split virtqueue in-order mergeable path: If Rx mergeable and in-order feature are
    both negotiated, this path will be selected.
+
 #. Split virtqueue in-order non-mergeable path: If in-order feature is negotiated and
    Rx mergeable is not negotiated, this path will be selected.
+
 #. Split virtqueue vectorized Rx path: If Rx mergeable is disabled and no Rx offload
    requested, this path will be selected.
 
@@ -477,16 +482,21 @@ according to below configuration:
 
 #. Packed virtqueue mergeable path: If Rx mergeable is negotiated, in-order feature
    is not negotiated, this path will be selected.
+
 #. Packed virtqueue non-mergeable path: If Rx mergeable and in-order feature are not
    negotiated, this path will be selected.
+
 #. Packed virtqueue in-order mergeable path: If in-order and Rx mergeable feature are
    both negotiated, this path will be selected.
+
 #. Packed virtqueue in-order non-mergeable path: If in-order feature is negotiated and
    Rx mergeable is not negotiated, this path will be selected.
+
 #. Packed virtqueue vectorized Rx path: If building and running environment support
    AVX512 && in-order feature is negotiated && Rx mergeable is not negotiated &&
    TCP_LRO Rx offloading is disabled && vectorized option enabled,
    this path will be selected.
+
 #. Packed virtqueue vectorized Tx path: If building and running environment support
    AVX512 && in-order feature is negotiated && vectorized option enabled,
    this path will be selected.
@@ -564,5 +574,7 @@ or configuration, below steps can help you identify which path you selected and
 root cause faster.
 
 #. Run vhost/virtio test case;
+
 #. Run "perf top" and check virtio Rx/Tx callback names;
+
 #. Identify which virtio path is selected refer to above table.
diff --git a/doc/guides/platform/octeontx2.rst b/doc/guides/platform/octeontx2.rst
index f7b5fdf22a..9640d39b75 100644
--- a/doc/guides/platform/octeontx2.rst
+++ b/doc/guides/platform/octeontx2.rst
@@ -104,7 +104,9 @@ where even VF bound to the first domain and odd VF bound to the second domain.
 Typical application usage models are,
 
 #. Communication between the Linux kernel and DPDK application.
+
 #. Exception path to Linux kernel from DPDK application as SW ``KNI`` replacement.
+
 #. Communication between two different DPDK applications.
 
 SDP interface
@@ -123,6 +125,7 @@ can bind PF or VF to use SDP interface and it will be enumerated as ethdev ports
 The primary use case for SDP is to enable the smart NIC use case. Typical usage models are,
 
 #. Communication channel between remote host and OCTEON TX2 SoC over PCIe.
+
 #. Transfer packets received from network interface to remote host over PCIe and
    vice-versa.
 
diff --git a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst
index ad91c6e5fc..ad2a8d04bb 100644
--- a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst
+++ b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst
@@ -204,7 +204,7 @@ To segment an outgoing packet, an application must:
    - a flag, that indicates whether the IPv4 headers of output segments should
      contain fixed or incremental ID values.
 
-2. Set the appropriate ol_flags in the mbuf.
+#. Set the appropriate ol_flags in the mbuf.
 
    - The GSO library use the value of an mbuf's ``ol_flags`` attribute to
      determine how a packet should be segmented. It is the application's
-- 
2.39.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2023-11-29 02:31:24.876054114 +0000
+++ 0002-doc-fix-some-ordered-lists.patch	2023-11-29 02:31:24.785770721 +0000
@@ -1 +1 @@
-From fc7428ead4ee6e1239ccd0bd4065edd974549ad6 Mon Sep 17 00:00:00 2001
+From 11b2f328f49fb7abc4b0e39f275d301af5fe4696 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit fc7428ead4ee6e1239ccd0bd4065edd974549ad6 ]
+
@@ -17 +18,0 @@
-Cc: stable at dpdk.org
@@ -23 +24 @@
- doc/guides/platform/cnxk.rst                         |  3 +++
+ doc/guides/platform/octeontx2.rst                    |  3 +++
@@ -28 +29 @@
-index ba6247170d..c22ce56a02 100644
+index 30a99be534..1922e1b444 100644
@@ -31 +32 @@
-@@ -217,6 +217,7 @@ Prerequisites for Rx interrupts
+@@ -301,6 +301,7 @@ Prerequisites for Rx interrupts
@@ -39 +40 @@
-@@ -379,12 +380,16 @@ according to below configuration:
+@@ -463,12 +464,16 @@ according to below configuration:
@@ -56 +57 @@
-@@ -393,16 +398,21 @@ according to below configuration:
+@@ -477,16 +482,21 @@ according to below configuration:
@@ -71,2 +72,2 @@
-    (AVX512 || NEON) && in-order feature is negotiated && Rx mergeable
-    is not negotiated && TCP_LRO Rx offloading is disabled && vectorized option enabled,
+    AVX512 && in-order feature is negotiated && Rx mergeable is not negotiated &&
+    TCP_LRO Rx offloading is disabled && vectorized option enabled,
@@ -76 +77 @@
-    (AVX512 || NEON)  && in-order feature is negotiated && vectorized option enabled,
+    AVX512 && in-order feature is negotiated && vectorized option enabled,
@@ -78 +79 @@
-@@ -480,5 +490,7 @@ or configuration, below steps can help you identify which path you selected and
+@@ -564,5 +574,7 @@ or configuration, below steps can help you identify which path you selected and
@@ -86,5 +87,5 @@
-diff --git a/doc/guides/platform/cnxk.rst b/doc/guides/platform/cnxk.rst
-index b3aa4de09d..b901062c93 100644
---- a/doc/guides/platform/cnxk.rst
-+++ b/doc/guides/platform/cnxk.rst
-@@ -113,7 +113,9 @@ where even VF bound to the first domain and odd VF bound to the second domain.
+diff --git a/doc/guides/platform/octeontx2.rst b/doc/guides/platform/octeontx2.rst
+index f7b5fdf22a..9640d39b75 100644
+--- a/doc/guides/platform/octeontx2.rst
++++ b/doc/guides/platform/octeontx2.rst
+@@ -104,7 +104,9 @@ where even VF bound to the first domain and odd VF bound to the second domain.
@@ -100 +101 @@
-@@ -132,6 +134,7 @@ can bind PF or VF to use SDP interface and it will be enumerated as ethdev ports
+@@ -123,6 +125,7 @@ can bind PF or VF to use SDP interface and it will be enumerated as ethdev ports
@@ -103 +104 @@
- #. Communication channel between remote host and cnxk SoC over PCIe.
+ #. Communication channel between remote host and OCTEON TX2 SoC over PCIe.
@@ -109 +110 @@
-index e605b86376..30d13bcc61 100644
+index ad91c6e5fc..ad2a8d04bb 100644