From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <john.mcnamara@intel.com>
Received: from mga05.intel.com (mga05.intel.com [192.55.52.43])
by dpdk.org (Postfix) with ESMTP id E4FE83989
for <dev@dpdk.org>; Tue, 30 Aug 2016 17:05:25 +0200 (CEST)
Received: from fmsmga002.fm.intel.com ([10.253.24.26])
by fmsmga105.fm.intel.com with ESMTP; 30 Aug 2016 08:05:24 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.30,257,1470726000"; d="scan'208";a="1049218463"
Received: from irsmsx110.ger.corp.intel.com ([163.33.3.25])
by fmsmga002.fm.intel.com with ESMTP; 30 Aug 2016 08:05:24 -0700
Received: from irsmsx103.ger.corp.intel.com ([169.254.3.204]) by
irsmsx110.ger.corp.intel.com ([169.254.15.113]) with mapi id 14.03.0248.002;
Tue, 30 Aug 2016 16:05:23 +0100
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>
Thread-Topic: [dpdk-dev] [PATCH 3/4] doc: add basic invocation info for
dpdk-devbind
Thread-Index: AQHR7kHcBea+xYvfY0uudOa7EZ4u0KBhwcOQ
Date: Tue, 30 Aug 2016 15:05:21 +0000
Message-ID: <B27915DBBA3421428155699D51E4CFE2025D8A60@IRSMSX103.ger.corp.intel.com>
References: <1470309419-4389-1-git-send-email-christian.ehrhardt@canonical.com>
<1470309419-4389-4-git-send-email-christian.ehrhardt@canonical.com>
In-Reply-To: <1470309419-4389-4-git-send-email-christian.ehrhardt@canonical.com>
Accept-Language: en-GB, en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
x-ctpclassification: CTP_IC
x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYmJkNmE4YTgtYTkwNi00YjNkLTkzZmYtMzlkMGY0N2RiNDM3IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IlVRMkRNdTlMSjlHSDBZNEhGQTNmR3BDZDdOcjdNR0VcL1dZbDV2N2VUU2xrPSJ9
x-originating-ip: [163.33.239.181]
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Subject: Re: [dpdk-dev] [PATCH 3/4] doc: add basic invocation info
for dpdk-devbind
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Tue, 30 Aug 2016 15:05:26 -0000
> -----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
>=20
> +
> +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=3Deth0
> + * the driver being used e.g. drv=3Digb_uio
> + * any suitable drivers not currently using that device
> + e.g. unused=3Digb_uio
> + NOTE: if this flag is passed along with a bind/unbind option, th=
e
> + 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=3Digb_uio" should be joined to, or aligned with, the pre=
vious
line.
Also, it would be better to quote any fixed width strings in the docs with =
````
quotes, like ``unused=3Digb_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