From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Iremonger, Bernard" <bernard.iremonger@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH 1/1] doc: correct Vhost Sample Application guide
Date: Wed, 9 Dec 2015 14:43:47 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE2023FFE7B@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1449664541-9546-1-git-send-email-bernard.iremonger@intel.com>
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Bernard Iremonger
> Sent: Wednesday, December 9, 2015 12:36 PM
> To: dev@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@intel.com>
Hi Bernard,
Thanks for that. One comment (in several places):
> .. code-block:: console
>
> - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir /mnt/huge -- -p 0x1 --dev-basename usvhost
> + user@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@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@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 \
--huge-dir /mnt/huge -- -p 0x1 --dev-basename usvhost
Or:
user@target:~$ ./build/app/vhost-switch -c f -n 4 \
--socket-mem 1024 \
--huge-dir /mnt/huge \
-- -p 0x1 --dev-basename usvhost
Regards,
John.
--
next prev parent reply other threads:[~2015-12-09 14:43 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-12-09 12:35 Bernard Iremonger
2015-12-09 13:36 ` Xie, Huawei
2015-12-09 14:43 ` Mcnamara, John [this message]
2015-12-09 16:10 ` Iremonger, Bernard
2015-12-09 14:50 ` Mcnamara, John
2015-12-09 15:09 ` Thomas Monjalon
2015-12-09 16:14 ` Iremonger, Bernard
2015-12-10 6:40 ` Yuanhan Liu
2015-12-09 17:18 ` [dpdk-dev] [PATCH v2 " Bernard Iremonger
2015-12-10 6:52 ` Yuanhan Liu
2015-12-10 9:58 ` Iremonger, Bernard
2015-12-10 12:10 ` Xie, Huawei
2015-12-10 13:19 ` Iremonger, Bernard
2015-12-10 13:33 ` Xie, Huawei
2015-12-10 11:23 ` [dpdk-dev] [PATCH v3] " Bernard Iremonger
2015-12-14 0:23 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=B27915DBBA3421428155699D51E4CFE2023FFE7B@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=bernard.iremonger@intel.com \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).