Skip to contentSkip to conversation

doc: clean vhost async path doc

PATCH Superseded [email protected] 4 participants 6 messages Jun 22, 2022 – Jul 1, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: clean vhost async path doc

From: Xuan Ding <[email protected]>

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

---
 doc/guides/prog_guide/vhost_lib.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
doc/guides/prog_guide/vhost_lib.rst +6 -6
index 628db3fc38..e93673ce68 100644
@@ -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.
Signature · 1 line
2.17.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 44 lines

-----Original Message-----
From: Ding, Xuan <[email protected]>
Sent: Wednesday, June 22, 2022 9:36 AM
To: [email protected]; Xia, Chenbo <[email protected]>
Cc: [email protected]; Hu, Jiayu <[email protected]>; Ding, Xuan <[email protected]>
Subject: [PATCH] doc: clean vhost async path doc

From: Xuan Ding <[email protected]>

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

---
 doc/guides/prog_guide/vhost_lib.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
doc/guides/prog_guide/vhost_lib.rst +1 -4
index 628db3fc38..e93673ce68 100644
@@ -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.

doc/guides/prog_guide/vhost_lib.rst +5 -2
+  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

#2 lore raw

PATCH v2 1/1 doc: clean vhost async path doc

In reply to [email protected]

From: Xuan Ding <[email protected]>

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

---
v2:
* fix a typo in commit log

---
 doc/guides/prog_guide/vhost_lib.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
doc/guides/prog_guide/vhost_lib.rst +6 -6
index 628db3fc38..e93673ce68 100644
@@ -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.
Signature · 1 line
2.17.1
#3 lore raw

PATCH v3 1/1 doc: clean vhost async path doc

In reply to [email protected]

From: Xuan Ding <[email protected]>

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.

---
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(-)
doc/guides/prog_guide/vhost_lib.rst +6 -6
index 628db3fc38..e93673ce68 100644
@@ -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.
Signature · 1 line
2.17.1
Reviewed-by on v3 1/1
#4 lore raw
Quoted 8 lines

-----Original Message-----
From: Ding, Xuan <[email protected]>
Sent: Wednesday, June 22, 2022 9:46 AM
To: [email protected]; Xia, Chenbo <[email protected]>
Cc: [email protected]; Hu, Jiayu <[email protected]>; Ding, Xuan <[email protected]>
Subject: [PATCH v3] doc: clean vhost async path doc

Quoted 8 lines

From: Xuan Ding <[email protected]>

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.

Patch seems good. But it needs to be applied after

http://patchwork.dpdk.org/project/dpdk/patch/[email protected]/

Quoted 35 lines

---
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(-)
doc/guides/prog_guide/vhost_lib.rst +6 -7
index 628db3fc38..e93673ce68 100644
@@ -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

#5 lore raw
In reply to [email protected]
Quoted 12 lines · On 6/22/22 03:45, [email protected] wrote:

From: Xuan Ding <[email protected]>

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.

---
v3:
* add Reviewd-by

Quoted 6 lines

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