From: Christian Ehrhardt <christian.ehrhardt@canonical.com>
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
Date: Thu, 4 Aug 2016 13:16:57 +0200 [thread overview]
Message-ID: <1470309419-4389-3-git-send-email-christian.ehrhardt@canonical.com> (raw)
In-Reply-To: <1470309419-4389-1-git-send-email-christian.ehrhardt@canonical.com>
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
diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 4435974..48fe890 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -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:
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
performance_thread
ipsec_secgw
pdump
+ pmdinfo
**Figures**
diff --git a/doc/guides/sample_app_ug/pmdinfo.rst b/doc/guides/sample_app_ug/pmdinfo.rst
new file mode 100644
index 0000000..6bbf7e2
--- /dev/null
+++ b/doc/guides/sample_app_ug/pmdinfo.rst
@@ -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.
--
2.7.4
next prev parent reply other threads:[~2016-08-04 11:17 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 ` Christian Ehrhardt [this message]
2016-08-30 14:59 ` [dpdk-dev] [PATCH 2/4] doc: add basic invocation info for dpdk-pmdinfo 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
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=1470309419-4389-3-git-send-email-christian.ehrhardt@canonical.com \
--to=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).