[dpdk-dev] [PATCH] doc: minor correction in document
Yigit, Ferruh
ferruh.yigit at intel.com
Tue Feb 2 13:59:34 CET 2016
On Mon, Feb 01, 2016 at 04:02:05PM +0000, Mcnamara, John wrote:
> > -----Original Message-----
> > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Ferruh Yigit
> > Sent: Friday, January 29, 2016 10:12 AM
> > To: dev at 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
More information about the dev
mailing list