Thread (5 messages) flat view 5 messages, 3 authors, 2016-02-09

Re: [PATCH] doc: minor correction in document

From: Mcnamara, John <hidden>
Date: 2016-02-01 16:02:15

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

John.
-- 
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help