debian/patches/dpdk-dev-v2-3-4-doc-add-basic-invocation-info-for-dpdk-pmdinfo.patch

   1 diff --git a/doc/guides/conf.py b/doc/guides/conf.py
   2 index 55b6b2f..c45c4be 100644
   3 --- a/doc/guides/conf.py
   4 +++ b/doc/guides/conf.py
   5 @@ -111,7 +111,9 @@ man_pages = [("testpmd_app_ug/run_app", "testpmd",
   6               ("tools/pdump", "dpdk-pdump",
   7                "enable packet capture on dpdk ports", "", 1),
   8               ("tools/proc_info", "dpdk-procinfo",
   9 -              "access dpdk port stats and memory info", "", 1)]
  10 +              "access dpdk port stats and memory info", "", 1),
  11 +             ("tools/pmdinfo", "dpdk-pmdinfo",
  12 +              "dump a PMDs hardware support info", "", 1)]
  13
  14  ######## :numref: fallback ########
  15  # The following hook functions add some simple handling for the :numref:
  16 diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst
  17 index d7654a2..80f2115 100644
  18 --- a/doc/guides/tools/index.rst
  19 +++ b/doc/guides/tools/index.rst
  20 @@ -37,4 +37,5 @@ Tool User Guides
  21
  22      proc_info
  23      pdump
  24 +    pmdinfo
  25
  26 diff --git a/doc/guides/tools/pmdinfo.rst b/doc/guides/tools/pmdinfo.rst
  27 new file mode 100644
  28 index 0000000..a90c59f
  29 --- /dev/null
  30 +++ b/doc/guides/tools/pmdinfo.rst
  31 @@ -0,0 +1,57 @@
  32 +
  33 +..  BSD LICENSE
  34 +    Copyright(c) 2016 Canonical Limited. All rights reserved.
  35 +
  36 +    Redistribution and use in source and binary forms, with or without
  37 +    modification, are permitted provided that the following conditions
  38 +    are met:
  39 +
  40 +    * Redistributions of source code must retain the above copyright
  41 +    notice, this list of conditions and the following disclaimer.
  42 +    * Redistributions in binary form must reproduce the above copyright
  43 +    notice, this list of conditions and the following disclaimer in
  44 +    the documentation and/or other materials provided with the
  45 +    distribution.
  46 +    * Neither the name of Intel Corporation nor the names of its
  47 +    contributors may be used to endorse or promote products derived
  48 +    from this software without specific prior written permission.
  49 +
  50 +    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51 +    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52 +    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53 +    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54 +    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55 +    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56 +    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57 +    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58 +    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59 +    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60 +    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61 +
  62 +
  63 +dpdk-pmdinfo Application
  64 +========================
  65 +
  66 +The ``dpdk-pmdinfo`` tool is a Data Plane Development Kit (DPDK) utility that
  67 +can dump a PMDs hardware support info.
  68 +
  69 +
  70 +Running the Application
  71 +-----------------------
  72 +
  73 +The tool has a number of command line options:
  74 +
  75 +.. code-block:: console
  76 +
  77 +
  78 +   dpdk-pmdinfo [-hrtp] [-d <pci id file] <elf-file>
  79 +
  80 +   -h, --help            Show a short help message and exit
  81 +   -r, --raw             Dump as raw json strings
  82 +   -d FILE, --pcidb=FILE Specify a pci database to get vendor names from
  83 +   -t, --table           Output information on hw support as a hex table
  84 +   -p, --plugindir       Scan dpdk for autoload plugins
  85 +
  86 +.. Note::
  87 +
  88 +   * Parameters inside the square brackets represents optional parameters.