[PATCH 1/5] doc: remove restriction on ixgbe vector support

[PATCH 1/5] doc: remove restriction on ixgbe vector support

[David Marchand]

The ixgbe driver has vector support for different architectures for a
while now.

Fixes: b20971b6cca0 ("net/ixgbe: implement vector driver for ARM")
Cc: stable@dpdk.org

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/nics/ixgbe.rst | 2 --
 1 file changed, 2 deletions(-)

diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst
index b1d77ab7ab..14573b542e 100644
--- a/doc/guides/nics/ixgbe.rst
+++ b/doc/guides/nics/ixgbe.rst
@@ -47,8 +47,6 @@ The wider register gives space to hold multiple packet buffers so as to save ins
 There is no change to PMD API. The RX/TX handler are the only two entries for vPMD packet I/O.
 They are transparently registered at runtime RX/TX execution if all condition checks pass.
 
-1.  To date, only an SSE version of IX GBE vPMD is available.
-
 Some constraints apply as pre-conditions for specific optimizations on bulk packet transfers.
 The following sections explain RX and TX constraints in the vPMD.
 
-- 
2.41.0

[PATCH 3/5] doc: fix some ordered lists

[David Marchand]

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(-)

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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index ba6247170d..c22ce56a02 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -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.
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.
 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.
 
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
@@ -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.41.0

[PATCH 4/5] doc: remove number of commands in vDPA guide

[David Marchand]

There are now 5 supported commands.

Fixes: 6505865aa8ed ("examples/vdpa: add statistics show command")
Cc: stable@dpdk.org

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/sample_app_ug/vdpa.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/doc/guides/sample_app_ug/vdpa.rst b/doc/guides/sample_app_ug/vdpa.rst
index cb9c4f2169..6b6de53e48 100644
--- a/doc/guides/sample_app_ug/vdpa.rst
+++ b/doc/guides/sample_app_ug/vdpa.rst
@@ -38,8 +38,7 @@ where
 * --iface specifies the path prefix of the UNIX domain socket file, e.g.
   /tmp/vhost-user-, then the socket files will be named as /tmp/vhost-user-<n>
   (n starts from 0).
-* --interactive means run the vdpa sample in interactive mode, currently 4
-  internal cmds are supported:
+* --interactive means run the vdpa sample in interactive mode:
 
   1. help: show help message
   2. list: list all available vdpa devices
-- 
2.41.0

Re: [PATCH 1/5] doc: remove restriction on ixgbe vector support

[Bruce Richardson]

On Thu, Nov 23, 2023 at 12:44:01PM +0100, David Marchand wrote:
> The ixgbe driver has vector support for different architectures for a
> while now.
> 
> Fixes: b20971b6cca0 ("net/ixgbe: implement vector driver for ARM")
> Cc: stable@dpdk.org
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Re: [PATCH 3/5] doc: fix some ordered lists

[Bruce Richardson]

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>

Re: [PATCH 4/5] doc: remove number of commands in vDPA guide

[Thomas Monjalon]

23/11/2023 12:44, David Marchand:
> There are now 5 supported commands.
> 
> Fixes: 6505865aa8ed ("examples/vdpa: add statistics show command")
> Cc: stable@dpdk.org
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
>  doc/guides/sample_app_ug/vdpa.rst | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/doc/guides/sample_app_ug/vdpa.rst b/doc/guides/sample_app_ug/vdpa.rst
> index cb9c4f2169..6b6de53e48 100644
> --- a/doc/guides/sample_app_ug/vdpa.rst
> +++ b/doc/guides/sample_app_ug/vdpa.rst
> @@ -38,8 +38,7 @@ where
>  * --iface specifies the path prefix of the UNIX domain socket file, e.g.
>    /tmp/vhost-user-, then the socket files will be named as /tmp/vhost-user-<n>
>    (n starts from 0).
> -* --interactive means run the vdpa sample in interactive mode, currently 4
> -  internal cmds are supported:
> +* --interactive means run the vdpa sample in interactive mode:

While modifying this line, I think uppercase "vDPA" should be used.

RE: [PATCH 3/5] doc: fix some ordered lists

[Dariusz Sosnowski]

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

Re: [PATCH 3/5] doc: fix some ordered lists

[David Marchand]

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.


-- 
David Marchand