[dpdk-dev] [PATCH 1/1] doc: correct Vhost Sample Application guide

Mcnamara, John john.mcnamara at intel.com
Wed Dec 9 15:43:47 CET 2015


> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Bernard Iremonger
> Sent: Wednesday, December 9, 2015 12:36 PM
> To: dev at dpdk.org
> Subject: [dpdk-dev] [PATCH 1/1] doc: correct Vhost Sample Application
> guide
> 
> correct sample console commands
> 
> Fixes: d0dff9ba445e ("doc: sample application user guide"
> Fixes: 9bc23cb8209c ("doc: add vhost-user to sample guide")
> Fixes: 43866bf71d58 ("doc: fix vhost sample parameter")
> Signed-off-by: Bernard Iremonger <bernard.iremonger at intel.com>

Hi Bernard,

Thanks for that. One comment (in several places):


>      .. code-block:: console
> 
> -        user at target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir /mnt/huge -- -p 0x1 --dev-basename usvhost
> +        user at target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- -p 0x1 --dev-basename usvhost

These long lines in code blocks don't render correctly in the PDF docs. The 
Documentation Guidelines suggest using a commandline line continuation
to maintain functionality within an 80 char doc limit:

   http://dpdk.org/doc/guides/contributing/documentation.html#code-and-literal-block-sections

So something like this:

    user at target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- -p 0x1 --dev-basename usvhost

Could be written as:

    user at target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 \
                         --huge-dir /mnt/huge -- -p 0x1 --dev-basename usvhost

Or: 

    user at target:~$ ./build/app/vhost-switch -c f -n 4 \
                                            --socket-mem 1024 \
                                            --huge-dir /mnt/huge \
                                            -- -p 0x1 --dev-basename usvhost

Regards,

John.
-- 



More information about the dev mailing list