From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 106D54CE7 for ; Tue, 30 Aug 2016 16:59:47 +0200 (CEST) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga101.jf.intel.com with ESMTP; 30 Aug 2016 07:59:47 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.30,257,1470726000"; d="scan'208";a="1043452655" Received: from irsmsx110.ger.corp.intel.com ([163.33.3.25]) by orsmga002.jf.intel.com with ESMTP; 30 Aug 2016 07:59:43 -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 15:59:41 +0100 From: "Mcnamara, John" To: Christian Ehrhardt , "thomas.monjalon@6wind.com" , "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH 2/4] doc: add basic invocation info for dpdk-pmdinfo Thread-Index: AQHR7kHY+y4jJZuumU+GK8A/pFWHvaBhv9qQ Date: Tue, 30 Aug 2016 14:59:40 +0000 Message-ID: References: <1470309419-4389-1-git-send-email-christian.ehrhardt@canonical.com> <1470309419-4389-3-git-send-email-christian.ehrhardt@canonical.com> In-Reply-To: <1470309419-4389-3-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: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYTMyNDBjNTAtMjMzOC00N2Y4LTk4ZjEtNTRhOTE0YzI1ODIzIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IkhuMUpoOXFGWjNrZFRPWFNuMEx3YmhNcTl4a2NxeDIwYnptTDRjQldHcm89In0= 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 2/4] doc: add basic invocation info for dpdk-pmdinfo X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 30 Aug 2016 14:59:48 -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 2/4] doc: add basic invocation info for dpdk- > pmdinfo >=20 > This summarizes the "how to call dpdk-pmdinfo" in one place to be picked > up by html/pdf/man-page docs. >=20 > ... > > # The following hook functions add some simple handling for the :numref: > diff --git a/doc/guides/sample_app_ug/index.rst > b/doc/guides/sample_app_ug/index.rst > index 96bb317..7801688 100644 > --- a/doc/guides/sample_app_ug/index.rst > +++ b/doc/guides/sample_app_ug/index.rst > @@ -77,6 +77,7 @@ Sample Applications User Guide I think these docs would be better in a "doc/guides/tools" directory. That would be clearer in terms to the documentation structure and also in terms of their functionality > +dpdk-pmdinfo Application > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +The ``dpdk-pmdinfo`` tool is a Data Plane Development Kit (DPDK) tool > +that can dump a PMDs hardware support info. To avoid using "tool" twice in the sentence you could use "utility" the second time. > + > + .. Note:: > + > + * The actual data is stored in the object files as > + PMD_INFO_STRING I'd leave this note out of the description. > +Running the Application > +----------------------- > + > +The tool has a number of command line options: > + > +.. code-block:: console > + > + > + dpdk-pmdinfo [-hrtp] [-d > + > + -h, --help show a short help message and exit > + -r, --raw Dump as raw json strings > + -d FILE, --pcidb=3DFILE > + specify a pci database to get vendor names from > + -t, --table output information on hw support as a hex table > + -p, --plugindir scan dpdk for autoload plugins > + One of the descriptions is in sentence case and the others aren't. It shoul= d be one or the other. I would use sentence case for all. =20