[dpdk-dev,2/4] doc: add basic invocation info for dpdk-pmdinfo
Commit Message
This summarizes the "how to call dpdk-pmdinfo" in one place to be picked
up by html/pdf/man-page docs.
Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
---
doc/guides/conf.py | 4 ++-
doc/guides/sample_app_ug/index.rst | 1 +
doc/guides/sample_app_ug/pmdinfo.rst | 62 ++++++++++++++++++++++++++++++++++++
3 files changed, 66 insertions(+), 1 deletion(-)
create mode 100644 doc/guides/sample_app_ug/pmdinfo.rst
Comments
> -----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
>
> 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.
On Tue, Aug 30, 2016 at 4:59 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 2/4] doc: add basic invocation info for dpdk-
> > pmdinfo
> >
[...]
> > --- 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
>
I agree that it represents the scope better then, but I was aligning myself
to the pdump and procinfo tools that are already there.
testpmd is a bit of an outlier, as that already has its own dir.
But I assume given the suggestion to move the new ones we would want to
move those other two as well then?
I thank that would serve consistency then - I'll prep a patch with that as
part of the series.
[...]
free-of-discussion ack to all other suggestions
@@ -98,7 +98,9 @@ man_pages = [("testpmd_app_ug/run_app", "testpmd",
("sample_app_ug/pdump", "dpdk-pdump",
"enable packet capture on dpdk ports", "", 1),
("sample_app_ug/proc_info", "dpdk-procinfo",
- "access dpdk port stats and memory info", "", 1)]
+ "access dpdk port stats and memory info", "", 1),
+ ("sample_app_ug/pmdinfo", "dpdk-pmdinfo",
+ "dump a PMDs hardware support info", "", 1)]
######## :numref: fallback ########
# The following hook functions add some simple handling for the :numref:
@@ -77,6 +77,7 @@ Sample Applications User Guide
performance_thread
ipsec_secgw
pdump
+ pmdinfo
**Figures**
new file mode 100644
@@ -0,0 +1,62 @@
+
+.. BSD LICENSE
+ Copyright(c) 2016 Canonical Limited. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
+ the documentation and/or other materials provided with the
+ distribution.
+ * Neither the name of Intel Corporation nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+dpdk-pmdinfo Application
+========================
+
+The ``dpdk-pmdinfo`` tool is a Data Plane Development Kit (DPDK) tool that can
+dump a PMDs hardware support info.
+
+ .. Note::
+
+ * The actual data is stored in the object files as PMD_INFO_STRING
+
+
+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
+
+.. Note::
+
+ * Parameters inside the square brackets represents optional parameters.