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

Iremonger, Bernard bernard.iremonger at intel.com
Wed Dec 9 17:10:29 CET 2015


Hi John,

<snip>

> 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.
> --

I will use a command line continuation character to stay within 80 character limit.

Regards,

Bernard.


More information about the dev mailing list