diff mbox series

[v3] doc: clean vhost async path doc

Message ID 20220622014556.105081-1-xuan.ding@intel.com (mailing list archive)
State Awaiting Upstream
Delegated to: Maxime Coquelin
Headers show
Series [v3] doc: clean vhost async path doc | expand

Checks

Context Check Description
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-testing warning apply patch failure
ci/checkpatch success coding style OK

Commit Message

Ding, Xuan June 22, 2022, 1:45 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 sub-section,
which makes the doc cleaner.

Signed-off-by: Xuan Ding <xuan.ding@intel.com>
Reviewed-by: Jiayu Hu <jiayu.hu@intel.com>
---
v3:
* add Reviewd-by

v2:
* fix a typo in commit log
---
 doc/guides/prog_guide/vhost_lib.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Xia, Chenbo June 23, 2022, 3:11 a.m. UTC | #1
> -----Original Message-----
> From: Ding, Xuan <xuan.ding@intel.com>
> Sent: Wednesday, June 22, 2022 9:46 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 v3] 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 sub-section,
> which makes the doc cleaner.
> 
> Signed-off-by: Xuan Ding <xuan.ding@intel.com>
> Reviewed-by: Jiayu Hu <jiayu.hu@intel.com>

Patch seems good. But it needs to be applied after

http://patchwork.dpdk.org/project/dpdk/patch/20220621072131.14756-1-xuan.ding@intel.com/

Reviewed-by: Chenbo Xia <chenbo.xia@intel.com>

> ---
> v3:
> * add Reviewd-by
> 
> v2:
> * fix a typo in commit log
> ---
>  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
Maxime Coquelin July 1, 2022, 1:56 p.m. UTC | #2
On 6/22/22 03:45, xuan.ding@intel.com wrote:
> 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 sub-section,
> which makes the doc cleaner.
> 
> Signed-off-by: Xuan Ding <xuan.ding@intel.com>
> Reviewed-by: Jiayu Hu <jiayu.hu@intel.com>
> ---
> v3:
> * add Reviewd-by
> 
> v2:
> * fix a typo in commit log
> ---
>   doc/guides/prog_guide/vhost_lib.rst | 12 ++++++------
>   1 file changed, 6 insertions(+), 6 deletions(-)
> 

Applied to dpdk-next-virtio/main.

Thanks,
Maxime
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.