[3/5] doc: fix some ordered lists
Checks
Commit Message
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: 85d9252e55f2 ("net/mlx5: add test for remote PD and CTX")
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")
Cc: stable@dpdk.org
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
doc/guides/nics/mlx5.rst | 21 +++++++++----------
doc/guides/nics/virtio.rst | 12 +++++++++++
doc/guides/platform/cnxk.rst | 3 +++
.../generic_segmentation_offload_lib.rst | 2 +-
4 files changed, 26 insertions(+), 12 deletions(-)
Comments
On Thu, Nov 23, 2023 at 12:44:03PM +0100, David Marchand wrote:
> 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: 85d9252e55f2 ("net/mlx5: add test for remote PD and CTX")
> 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")
> Cc: stable@dpdk.org
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Hi,
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index
> 45379960f0..39a8c5d7b4 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -2326,19 +2326,18 @@ This command performs:
>
> #. Call the regular ``port attach`` function with updated identifier.
>
> -For example, to attach a port whose PCI address is ``0000:0a:00.0`` -and its
> socket path is ``/var/run/import_ipc_socket``:
> + For example, to attach a port whose PCI address is ``0000:0a:00.0``
> + and its socket path is ``/var/run/import_ipc_socket``:
>
> -.. code-block:: console
> -
> - testpmd> mlx5 port attach 0000:0a:00.0
> socket=/var/run/import_ipc_socket
> - testpmd: MLX5 socket path is /var/run/import_ipc_socket
> - testpmd: Attach port with extra devargs
> 0000:0a:00.0,cmd_fd=40,pd_handle=1
> - Attaching a new port...
> - EAL: Probe PCI driver: mlx5_pci (15b3:101d) device: 0000:0a:00.0 (socket
> 0)
> - Port 0 is attached. Now total ports is 1
> - Done
> + .. code-block:: console
>
> + testpmd> mlx5 port attach 0000:0a:00.0
> socket=/var/run/import_ipc_socket
> + testpmd: MLX5 socket path is /var/run/import_ipc_socket
> + testpmd: Attach port with extra devargs
> 0000:0a:00.0,cmd_fd=40,pd_handle=1
> + Attaching a new port...
> + EAL: Probe PCI driver: mlx5_pci (15b3:101d) device: 0000:0a:00.0 (socket
> 0)
> + Port 0 is attached. Now total ports is 1
> + Done
>
> port map external Rx queue
> ~~~~~~~~~~~~~~~~~~~~~~~~~~
The preceding list explains what "mlx5 port attach" command does and the following section provides an example of usage.
I don't think this section should be a part of that list.
Best regards,
Dariusz Sosnowski
On Thu, Nov 23, 2023 at 6:22 PM Dariusz Sosnowski <dsosnowski@nvidia.com> wrote:
>
> Hi,
>
> > diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index
> > 45379960f0..39a8c5d7b4 100644
> > --- a/doc/guides/nics/mlx5.rst
> > +++ b/doc/guides/nics/mlx5.rst
> > @@ -2326,19 +2326,18 @@ This command performs:
> >
> > #. Call the regular ``port attach`` function with updated identifier.
> >
> > -For example, to attach a port whose PCI address is ``0000:0a:00.0`` -and its
> > socket path is ``/var/run/import_ipc_socket``:
> > + For example, to attach a port whose PCI address is ``0000:0a:00.0``
> > + and its socket path is ``/var/run/import_ipc_socket``:
> >
> > -.. code-block:: console
> > -
> > - testpmd> mlx5 port attach 0000:0a:00.0
> > socket=/var/run/import_ipc_socket
> > - testpmd: MLX5 socket path is /var/run/import_ipc_socket
> > - testpmd: Attach port with extra devargs
> > 0000:0a:00.0,cmd_fd=40,pd_handle=1
> > - Attaching a new port...
> > - EAL: Probe PCI driver: mlx5_pci (15b3:101d) device: 0000:0a:00.0 (socket
> > 0)
> > - Port 0 is attached. Now total ports is 1
> > - Done
> > + .. code-block:: console
> >
> > + testpmd> mlx5 port attach 0000:0a:00.0
> > socket=/var/run/import_ipc_socket
> > + testpmd: MLX5 socket path is /var/run/import_ipc_socket
> > + testpmd: Attach port with extra devargs
> > 0000:0a:00.0,cmd_fd=40,pd_handle=1
> > + Attaching a new port...
> > + EAL: Probe PCI driver: mlx5_pci (15b3:101d) device: 0000:0a:00.0 (socket
> > 0)
> > + Port 0 is attached. Now total ports is 1
> > + Done
> >
> > port map external Rx queue
> > ~~~~~~~~~~~~~~~~~~~~~~~~~~
> The preceding list explains what "mlx5 port attach" command does and the following section provides an example of usage.
> I don't think this section should be a part of that list.
Re-reading this section, I agree.
I will drop this hunk.
Thanks Dariusz.
@@ -2326,19 +2326,18 @@ This command performs:
#. Call the regular ``port attach`` function with updated identifier.
-For example, to attach a port whose PCI address is ``0000:0a:00.0``
-and its socket path is ``/var/run/import_ipc_socket``:
+ For example, to attach a port whose PCI address is ``0000:0a:00.0``
+ and its socket path is ``/var/run/import_ipc_socket``:
-.. code-block:: console
-
- testpmd> mlx5 port attach 0000:0a:00.0 socket=/var/run/import_ipc_socket
- testpmd: MLX5 socket path is /var/run/import_ipc_socket
- testpmd: Attach port with extra devargs 0000:0a:00.0,cmd_fd=40,pd_handle=1
- Attaching a new port...
- EAL: Probe PCI driver: mlx5_pci (15b3:101d) device: 0000:0a:00.0 (socket 0)
- Port 0 is attached. Now total ports is 1
- Done
+ .. code-block:: console
+ testpmd> mlx5 port attach 0000:0a:00.0 socket=/var/run/import_ipc_socket
+ testpmd: MLX5 socket path is /var/run/import_ipc_socket
+ testpmd: Attach port with extra devargs 0000:0a:00.0,cmd_fd=40,pd_handle=1
+ Attaching a new port...
+ EAL: Probe PCI driver: mlx5_pci (15b3:101d) device: 0000:0a:00.0 (socket 0)
+ Port 0 is attached. Now total ports is 1
+ Done
port map external Rx queue
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -217,6 +217,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
@@ -379,12 +380,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.
@@ -393,16 +398,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 || 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,
this path will be selected.
@@ -480,5 +490,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.
@@ -113,7 +113,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
@@ -132,6 +134,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 cnxk SoC over PCIe.
+
#. Transfer packets received from network interface to remote host over PCIe and
vice-versa.
@@ -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