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

[Kevin Traynor]

Hi,

FYI, your patch has been queued to stable release 21.11.6

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/12/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/kevintraynor/dpdk-stable

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable/commit/82a6991ac2ddb5b0528155948c7e965da416e018

Thanks.

Kevin

---
>From 82a6991ac2ddb5b0528155948c7e965da416e018 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/cnxk.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 eef0cc2a5f..0de445c6e0 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -305,4 +305,5 @@ Prerequisites for Rx interrupts
 
 To support Rx interrupts,
+
 #. Check if guest kernel supports VFIO-NOIOMMU:
 
@@ -467,10 +468,14 @@ 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.
@@ -481,14 +486,19 @@ 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 || NEON) && 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 || NEON)  && in-order feature is negotiated && vectorized option enabled,
@@ -568,4 +578,6 @@ 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/cnxk.rst b/doc/guides/platform/cnxk.rst
index a2667acd35..8eff2c4cd9 100644
--- a/doc/guides/platform/cnxk.rst
+++ b/doc/guides/platform/cnxk.rst
@@ -106,5 +106,7 @@ 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.
 
@@ -125,4 +127,5 @@ The primary use case for SDP is to enable the smart NIC use case. Typical usage
 
 #. Communication channel between remote host and cnxk 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 e605b86376..30d13bcc61 100644
--- a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst
+++ b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst
@@ -205,5 +205,5 @@ To segment an outgoing packet, an application must:
      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
-- 
2.43.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2023-12-07 11:18:59.945290378 +0000
+++ 0014-doc-fix-some-ordered-lists.patch	2023-12-07 11:18:59.631873941 +0000
@@ -1 +1 @@
-From fc7428ead4ee6e1239ccd0bd4065edd974549ad6 Mon Sep 17 00:00:00 2001
+From 82a6991ac2ddb5b0528155948c7e965da416e018 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit fc7428ead4ee6e1239ccd0bd4065edd974549ad6 ]
+
@@ -17 +18,0 @@
-Cc: stable at dpdk.org
@@ -28 +29 @@
-index ba6247170d..c22ce56a02 100644
+index eef0cc2a5f..0de445c6e0 100644
@@ -31 +32 @@
-@@ -218,4 +218,5 @@ Prerequisites for Rx interrupts
+@@ -305,4 +305,5 @@ Prerequisites for Rx interrupts
@@ -37 +38 @@
-@@ -380,10 +381,14 @@ according to below configuration:
+@@ -467,10 +468,14 @@ according to below configuration:
@@ -52 +53 @@
-@@ -394,14 +399,19 @@ according to below configuration:
+@@ -481,14 +486,19 @@ according to below configuration:
@@ -72 +73 @@
-@@ -481,4 +491,6 @@ root cause faster.
+@@ -568,4 +578,6 @@ root cause faster.
@@ -80 +81 @@
-index b3aa4de09d..b901062c93 100644
+index a2667acd35..8eff2c4cd9 100644
@@ -83 +84 @@
-@@ -114,5 +114,7 @@ Typical application usage models are,
+@@ -106,5 +106,7 @@ Typical application usage models are,
@@ -91 +92 @@
-@@ -133,4 +135,5 @@ The primary use case for SDP is to enable the smart NIC use case. Typical usage
+@@ -125,4 +127,5 @@ The primary use case for SDP is to enable the smart NIC use case. Typical usage