[v1,3/4] doc: update vhost sample doc for vhost async data path
diff mbox series

Message ID 20200910064351.35513-4-Cheng1.jiang@intel.com
State Superseded
Delegated to: Maxime Coquelin
Headers show
Series
  • add async data path in vhost sample
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Cheng Jiang Sept. 10, 2020, 6:43 a.m. UTC
Add vhost async driver arguments information for vhost async data
path in vhost sample application.

Signed-off-by: Cheng Jiang <Cheng1.jiang@intel.com>
---
 doc/guides/sample_app_ug/vhost.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

Patch
diff mbox series

diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index b7ed4f8bd..c8b5c7c9a 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -162,6 +162,16 @@  enabled and cannot be disabled.
 A very simple vhost-user net driver which demonstrates how to use the generic
 vhost APIs will be used when this option is given. It is disabled by default.
 
+**--async_vhost_driver**
+Async vhost-user net driver which demonstrates how to use the async vhost APIs
+will be used when this option is given. It is disabled by default.
+
+**--dmas**
+This parameter is used to specify the assigned DMA device of a vhost device.
+For example --dmas [txd0@00:04.0,txd1@00:04.1] means use CBDMA channel 00:04.0
+for vhost device 0 enqueue operation and use CBDMA channel 00:04.1 for vhost
+device 1 enqueue operation.
+
 Common Issues
 -------------