diff mbox series

[v3] doc: add note for builtin-net-driver option

Message ID 20180731160039.10613-1-yong.liu@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v3] doc: add note for builtin-net-driver option |

Checks

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

Commit Message

Marvin Liu July 31, 2018, 4 p.m. UTC 
  Very simple version of vhost-user driver in vhost sample will be used if
builtin-net-driver option is enabled. This driver is based on generic
vhost lib APIs. Unfortunately, the implementation is incompatible with
QEMU as protocol feature is not supported.

Signed-off-by: Marvin Liu <yong.liu@intel.com>

Comments

John McNamara Aug. 7, 2018, 1:52 p.m. UTC | #1 
> -----Original Message-----
> From: Liu, Yong
> Sent: Tuesday, July 31, 2018 5:01 PM
> To: Mcnamara, John <john.mcnamara@intel.com>; Bie, Tiwei
> <tiwei.bie@intel.com>; dev@dpdk.org
> Cc: Liu, Yong <yong.liu@intel.com>
> Subject: [PATCH v3] doc: add note for builtin-net-driver option
> 
> Very simple version of vhost-user driver in vhost sample will be used if
> builtin-net-driver option is enabled. This driver is based on generic vhost
> lib APIs. Unfortunately, the implementation is incompatible with QEMU as
> protocol feature is not supported.
> 
> Signed-off-by: Marvin Liu <yong.liu@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon Aug. 9, 2018, 7:21 p.m. UTC | #2 
> > Very simple version of vhost-user driver in vhost sample will be used if
> > builtin-net-driver option is enabled. This driver is based on generic vhost
> > lib APIs. Unfortunately, the implementation is incompatible with QEMU as
> > protocol feature is not supported.
> > 
> > Signed-off-by: Marvin Liu <yong.liu@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks
diff mbox series

Patch

diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index 9112e7897..fd42cb3f7 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -158,6 +158,10 @@  when disabling VLAN strip. Such feature, which heavily depends on hardware,
 should be removed from this example to reduce confusion. Now, VLAN strip is
 enabled and cannot be disabled.
 
+**--builtin-net-driver**
+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.
+
 Common Issues
 -------------
 
@@ -192,3 +196,8 @@  Common Issues
   according to the NIC's property. ::
 
       make EXTRA_CFLAGS="-DMAX_QUEUES=320"
+
+* Option "builtin-net-driver" is incompatible with QEMU
+
+  QEMU vhost net device start will fail if protocol feature is not negotiated.
+  DPDK virtio-user pmd can be the replacement of QEMU.