From mboxrd@z Thu Jan  1 00:00:00 1970
From: Tiwei Bie <tiwei.bie@intel.com>
Subject: Re: [PATCH v2] doc: add note for builtin-net-driver
	option
Date: Tue, 31 Jul 2018 15:27:10 +0800
Message-ID: <20180731072710.GA77155@debian.sh.intel.com>
References: <20180725171224.21113-1-yong.liu@intel.com>
 <20180726142738.58543-1-yong.liu@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Cc: marko.kovacevic@intel.com, dev@dpdk.org
To: Marvin Liu <yong.liu@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mga12.intel.com (mga12.intel.com [192.55.52.136])
 by dpdk.org (Postfix) with ESMTP id B9EC314E8
 for <dev@dpdk.org>; Tue, 31 Jul 2018 09:29:18 +0200 (CEST)
Content-Disposition: inline
In-Reply-To: <20180726142738.58543-1-yong.liu@intel.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

On Thu, Jul 26, 2018 at 10:27:38PM +0800, Marvin Liu wrote:
> Option builtin-net-driver is used to demonstrate how to implement
> vhost-user driver based on vhost lib APIs. Unfortunately, very simple
> vhost driver in vhost sample is incompatible with QEMU as protocol
> feature not supported.
> 
> Signed-off-by: Marvin Liu <yong.liu@intel.com>
> ---
> v2:
> * Updated descriptions.
> ---
> diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
> index 9112e7897..396d83211 100644
> --- a/doc/guides/sample_app_ug/vhost.rst
> +++ b/doc/guides/sample_app_ug/vhost.rst
> @@ -158,6 +158,11 @@ 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**
> +Very simple enqueue and dequeue function will be used when this option is
> +given. It can demonstrate how to construct vhost-user driver with vhost lib
> +APIs. It is disabled by default.

Maybe something like:

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 +197,8 @@ Common Issues
>    according to the NIC's property. ::
>  
>        make EXTRA_CFLAGS="-DMAX_QUEUES=320"
> +
> +* Option "builtin-net-driver" is incompatible with QEMU.

Better to remove above '.'

> +
> +  QEMU vhost net device start will fail if protocol feature is not
> +  negotiated. DPDK virtio-user can be the replacement of QEMU.
> -- 
> 2.17.0
>