> -----Original Message----- > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Christian Ehrhardt > Sent: Thursday, August 4, 2016 12:17 PM > To: christian.ehrhardt at canonical.com; thomas.monjalon at 6wind.com; > dev at dpdk.org > Subject: [dpdk-dev] [PATCH 2/4] doc: add basic invocation info for dpdk- > pmdinfo > > This summarizes the "how to call dpdk-pmdinfo" in one place to be picked > up by html/pdf/man-page docs. > > ... > > # 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 > +======================== > + > +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 <pci id file] <elf-file> > + > + -h, --help show a short help message and exit > + -r, --raw Dump as raw json strings > + -d FILE, --pcidb=FILE > + 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 should be one or the other. I would use sentence case for all.
