[dpdk-dev] [PATCH] doc: fix vhost guide

[Igor Ryzhov]

Hello, Changchun.

Previous paragraph says «To enable vhost, turn on vhost library in the configure file config/common_linuxapp», but string in a code-block is «CONFIG_RTE_LIBRTE_VHOST=n». I thought that idea is to use the default string from the config file that user have to change, not already changed string. So I used the same style.

Regards,
Igor

> 13 апр. 2015 г., в 7:52, Ouyang, Changchun <changchun.ouyang at intel.com> написал(а):
> 
> Hi Igor,
> 
> Good catch, comments as below.
> 
>> -----Original Message-----
>> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Igor Ryzhov
>> Sent: Thursday, April 9, 2015 12:31 AM
>> To: dev at dpdk.org
>> Cc: Igor Ryzhov
>> Subject: [dpdk-dev] [PATCH] doc: fix vhost guide
>> 
>> Guide says that a configure parameter to choose between vhost cuse and
>> vhost user will be introduced in the future, but it’s already added by commit
>> 28a1ccca41bf.
>> 
>> Signed-off-by: Igor Ryzhov <iryzhov at nfware.com>
>> ---
>> doc/guides/sample_app_ug/vhost.rst | 7 +++----
>> 1 file changed, 3 insertions(+), 4 deletions(-)
>> 
>> diff --git a/doc/guides/sample_app_ug/vhost.rst
>> b/doc/guides/sample_app_ug/vhost.rst
>> index 8a7eb3b..df8cd8c 100644
>> --- a/doc/guides/sample_app_ug/vhost.rst
>> +++ b/doc/guides/sample_app_ug/vhost.rst
>> @@ -309,13 +309,12 @@ Compiling the Sample Code
>> 
>>         CONFIG_RTE_LIBRTE_VHOST=n
>> 
>> -    vhost user is turned on by default in the lib/librte_vhost/Makefile.
>> -    To enable vhost cuse, uncomment vhost cuse and comment vhost user
>> manually. In future, a configure will be created for switch between two
>> implementations.
>> +    vhost user is turned on by default in the configure file
>> config/common_linuxapp.
>> +    To enable vhost cuse, disable vhost user.
>> 
>>     .. code-block:: console
>> 
>> -        SRCS-$(CONFIG_RTE_LIBRTE_VHOST) += vhost_cuse/vhost-net-cdev.c
>> vhost_cuse/virtio-net-cdev.c vhost_cuse/eventfd_copy.c
>> -        #SRCS-$(CONFIG_RTE_LIBRTE_VHOST) += vhost_user/vhost-net-user.c
>> vhost_user/virtio-net-user.c vhost_user/fd_man.c
>> +        CONFIG_RTE_LIBRTE_VHOST_USER=y
> 
> If it wants to guide user how to enable vhost cuse, then I think
> It makes sense to change it into:  CONFIG_RTE_LIBRTE_VHOST_USER=n
> 
> Thanks
> Changchun