From: "Yigit, Ferruh" <ferruh.yigit@intel.com>
To: "Mcnamara, John" <john.mcnamara@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc: minor correction in document
Date: Tue, 2 Feb 2016 12:59:34 +0000 [thread overview]
Message-ID: <20160202125934.GA11000@sivlogin002.ir.intel.com> (raw)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE202447674@IRSMSX103.ger.corp.intel.com>
On Mon, Feb 01, 2016 at 04:02:05PM +0000, Mcnamara, John wrote:
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> > Sent: Friday, January 29, 2016 10:12 AM
> > To: dev@dpdk.org
> > Subject: [dpdk-dev] [PATCH] doc: minor correction in document
> >
> > ...
> >
> > * html output converts "--" to "-", this is wrong when explaining the
> > command arguments, used "option list" to fix this:
> >
> > http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-
> > lists
>
> Hi Ferruh,
>
> That is interesting. I wasn't aware of that option. That would make the documentation
> of commandline options very clean.
>
> However, it doesn't render as wrapped text in the Html output and has scroll bars instead.
> This make it a little hard to read.
>
> Maybe as a workaround we could just use fixed width quotes like other places in the docs.
> Like this:
>
>
> * ``--proc-type``: for specifying a given process ...
> * ``--file-prefix``: to allow processes that do not ...
>
Thank you for the workaround, I will update according.
Thanks,
ferruh
next prev parent reply other threads:[~2016-02-02 12:59 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-01-29 10:11 Ferruh Yigit
2016-02-01 16:02 ` Mcnamara, John
2016-02-02 12:59 ` Yigit, Ferruh [this message]
2016-02-02 13:11 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
2016-02-09 11:12 ` 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=20160202125934.GA11000@sivlogin002.ir.intel.com \
--to=ferruh.yigit@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
/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).