From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Christian Ehrhardt <christian.ehrhardt@canonical.com>,
"thomas.monjalon@6wind.com" <thomas.monjalon@6wind.com>,
"dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH 3/4] doc: add basic invocation info for dpdk-devbind
Date: Tue, 30 Aug 2016 15:05:21 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE2025D8A60@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1470309419-4389-4-git-send-email-christian.ehrhardt@canonical.com>
> -----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
next prev parent reply other threads:[~2016-08-30 15:05 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-04 11:16 [dpdk-dev] [PATCH 0/4] provide man pages for binaries provided by DPDK Christian Ehrhardt
2016-08-04 11:16 ` [dpdk-dev] [PATCH 1/4] doc: rendering and installation of man pages Christian Ehrhardt
2016-08-30 14:52 ` Mcnamara, John
2016-08-04 11:16 ` [dpdk-dev] [PATCH 2/4] doc: add basic invocation info for dpdk-pmdinfo Christian Ehrhardt
2016-08-30 14:59 ` Mcnamara, John
2016-08-31 7:29 ` Christian Ehrhardt
2016-08-04 11:16 ` [dpdk-dev] [PATCH 3/4] doc: add basic invocation info for dpdk-devbind Christian Ehrhardt
2016-08-30 15:05 ` Mcnamara, John [this message]
2016-08-31 7:47 ` Christian Ehrhardt
2016-08-04 11:16 ` [dpdk-dev] [PATCH 4/4] doc: make the devbind man page be part of section 8 Christian Ehrhardt
2016-08-30 15:12 ` Mcnamara, John
2016-08-31 6:45 ` Christian Ehrhardt
2016-08-30 14:51 ` [dpdk-dev] [PATCH 0/4] provide man pages for binaries provided by DPDK Mcnamara, John
2016-08-31 5:54 ` Panu Matilainen
2016-08-31 6:46 ` Christian Ehrhardt
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 " Christian Ehrhardt
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 1/4] doc: move tool guides in their own subdirectory Christian Ehrhardt
2016-09-26 15:13 ` Mcnamara, John
2016-09-26 16:16 ` Christian Ehrhardt
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 2/4] doc: rendering and installation of man pages Christian Ehrhardt
2016-09-26 15:14 ` Mcnamara, John
2016-10-26 21:13 ` Thomas Monjalon
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 3/4] doc: add basic invocation info for dpdk-pmdinfo Christian Ehrhardt
2016-09-26 15:14 ` Mcnamara, John
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 4/4] doc: add basic invocation info for dpdk-devbind Christian Ehrhardt
2016-09-26 15:15 ` Mcnamara, John
2016-09-14 11:58 ` [dpdk-dev] [PATCH v2 0/4] provide man pages for binaries provided by DPDK Luca Boccassi
2016-10-26 21:32 ` 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=B27915DBBA3421428155699D51E4CFE2025D8A60@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=christian.ehrhardt@canonical.com \
--cc=dev@dpdk.org \
--cc=thomas.monjalon@6wind.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).