diff mbox series

doc: clean vhost async path doc

Message ID 20220622013535.100253-1-xuan.ding@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Maxime Coquelin
Headers
Series doc: clean vhost async path doc |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Ding, Xuan June 22, 2022, 1:35 a.m. UTC 
  From: Xuan Ding <xuan.ding@intel.com>

This patch moves the 'Recommended IOVA mode in async datapath'
section under 'Vhost asynchronous data path' as a subsection,
which make the doc cleaner.

Signed-off-by: Xuan Ding <xuan.ding@intel.com>
---
 doc/guides/prog_guide/vhost_lib.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Hu, Jiayu June 22, 2022, 1:42 a.m. UTC | #1 
Reviewed-by: Jiayu Hu <jiayu.hu@intel.com>

> -----Original Message-----
> From: Ding, Xuan <xuan.ding@intel.com>
> Sent: Wednesday, June 22, 2022 9:36 AM
> To: maxime.coquelin@redhat.com; Xia, Chenbo <chenbo.xia@intel.com>
> Cc: dev@dpdk.org; Hu, Jiayu <jiayu.hu@intel.com>; Ding, Xuan
> <xuan.ding@intel.com>
> Subject: [PATCH] doc: clean vhost async path doc
> 
> From: Xuan Ding <xuan.ding@intel.com>
> 
> This patch moves the 'Recommended IOVA mode in async datapath'
> section under 'Vhost asynchronous data path' as a subsection, which make
> the doc cleaner.
> 
> Signed-off-by: Xuan Ding <xuan.ding@intel.com>
> ---
>  doc/guides/prog_guide/vhost_lib.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/doc/guides/prog_guide/vhost_lib.rst
> b/doc/guides/prog_guide/vhost_lib.rst
> index 628db3fc38..e93673ce68 100644
> --- a/doc/guides/prog_guide/vhost_lib.rst
> +++ b/doc/guides/prog_guide/vhost_lib.rst
> @@ -488,11 +488,11 @@ support sharing DMA channels among vrings.
>    not poll completed will cause the DMA ring to be full, which will
>    result in packet loss eventually.
> 
> -Recommended IOVA mode in async datapath
> ----------------------------------------
> +* Recommended IOVA mode in async datapath
> 
> -When DMA devices are bound to VFIO driver, VA mode is recommended.
> -For PA mode, page by page mapping may exceed IOMMU's max capability, -
> better to use 1G guest hugepage.
> +  When DMA devices are bound to VFIO driver, VA mode is recommended.
> +  For PA mode, page by page mapping may exceed IOMMU's max capability,
> + better to use 1G guest hugepage.
> 
> -For UIO driver, any VFIO related error message can be ignored.
> +  For UIO driver or kernel driver, any VFIO related error messages  can
> + be ignored.
> --
> 2.17.1
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst
index 628db3fc38..e93673ce68 100644
--- a/doc/guides/prog_guide/vhost_lib.rst
+++ b/doc/guides/prog_guide/vhost_lib.rst
@@ -488,11 +488,11 @@  support sharing DMA channels among vrings.
   not poll completed will cause the DMA ring to be full, which will
   result in packet loss eventually.
 
-Recommended IOVA mode in async datapath
----------------------------------------
+* Recommended IOVA mode in async datapath
 
-When DMA devices are bound to VFIO driver, VA mode is recommended.
-For PA mode, page by page mapping may exceed IOMMU's max capability,
-better to use 1G guest hugepage.
+  When DMA devices are bound to VFIO driver, VA mode is recommended.
+  For PA mode, page by page mapping may exceed IOMMU's max capability,
+  better to use 1G guest hugepage.
 
-For UIO driver, any VFIO related error message can be ignored.
+  For UIO driver or kernel driver, any VFIO related error messages
+  can be ignored.