Skip to content

Commit

Permalink
doc: fix some ordered lists
Browse files Browse the repository at this point in the history
[ 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: 26b683b ("net/virtio: setup Rx queue interrupts")
Fixes: 9dcf5d1 ("doc: clarify path selection in virtio guide")
Fixes: 68a03ef ("doc: add Marvell cnxk platform guide")
Fixes: f6010c7 ("doc: add GSO programmer's guide")

Signed-off-by: David Marchand <david.marchand@redhat.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  • Loading branch information
david-marchand authored and kevintraynor committed Dec 5, 2023
1 parent f8a3dcb commit 82a6991
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
12 changes: 12 additions & 0 deletions doc/guides/nics/virtio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,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
Expand Down Expand Up @@ -466,12 +467,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.

Expand All @@ -480,16 +485,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.
Expand Down Expand Up @@ -567,5 +577,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.
3 changes: 3 additions & 0 deletions doc/guides/platform/cnxk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,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
Expand All @@ -124,6 +126,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.

Expand Down
2 changes: 1 addition & 1 deletion doc/guides/prog_guide/generic_segmentation_offload_lib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 82a6991

Please sign in to comment.