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

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