Re: [PATCH 3/4] doc: add basic invocation info for dpdk-devbind

[Christian Ehrhardt <christian.ehrhardt@canonical.com>]

Hi,
thanks for sharing your RST experience - I didn't see the rst issues before.
Fixed them all and checked html/man output again - looking good to me.

On Tue, Aug 30, 2016 at 5:05 PM, Mcnamara, John <john.mcnamara@intel.com>
wrote:

> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Christian Ehrhardt
> > Sent: Thursday, August 4, 2016 12:17 PM
> > To: christian.ehrhardt@canonical.com; thomas.monjalon@6wind.com;
> > dev@dpdk.org
> > Subject: [dpdk-dev] [PATCH 3/4] doc: add basic invocation info for dpdk-
> > devbind
> >
> > +
> > +OPTIONS
> > +-------
> > +
> > +* ``--help, --usage``
> > +
> > +        Display usage information and quit
> > +
> > +* ``-s, --status``
> > +
> > +        Print the current status of all known network interfaces.
> > +        For each device, it displays the PCI domain, bus, slot and
> > function,
> > +        along with a text description of the device. Depending upon
> > whether the
> > +        device is being used by a kernel driver, the igb_uio driver, or
> > no
> > +        driver, other relevant information will be displayed:
> > +        * the Linux interface name e.g. if=eth0
> > +        * the driver being used e.g. drv=igb_uio
> > +        * any suitable drivers not currently using that device
> > +            e.g. unused=igb_uio
> > +        NOTE: if this flag is passed along with a bind/unbind option,
> the
> > +        status display will always occur after the other operations have
> > taken
> > +        place.
>
> There are a few RST errors in this file. One of theme relates to the second
> level bullet list above. There should be a blank line before and after the
> list.
>
> Also, "e.g. unused=igb_uio" should be joined to, or aligned with, the
> previous
> line.
>
> Also, it would be better to quote any fixed width strings in the docs with
> ````
> quotes, like ``unused=igb_uio``. This could be applied to any of the
> ``--options``
> in the text as well.
> > +Examples
> > +--------
> > +
> > +To display current device status:
> > +.. code-block:: console
> > +
> > +   dpdk-devbind --status
> > +
>
> All the "code-block" directives should have a blank line before them.
> However it is probably better to use the simpler :: directive, like:
>
>     To display current device status::
>
>         dpdk-devbind --status
>
>


-- 
Christian Ehrhardt
Software Engineer, Ubuntu Server
Canonical Ltd