[dpdk-dev] [PATCH v2 00/10] doc: consolidate common part among PMD docs

Shijith Thotton shijith.thotton at caviumnetworks.com
Tue Apr 11 20:56:40 CEST 2017


Steps for compiling PMDs and running testpmd in Linux are common among
drivers. So it can be moved to a new document and be referred from other
driver documentations.

This patchset adds a new section for compiling and testing a PMD in
Network Interface Controller Drivers documentation. Other driver docs
with similar part are replaced with reference to this section.

v2 changes:
* Make doc to compile and test PMD more generic.
* Modify docs of ark and thunderx.
* Keep testpmd logs in PMD docs.

v1 changes:
* Address review comments from John.
 - Corrections to documentation.
 - Create a new section after NIC overview for the doc.
 - Refer the section instead of including it in PMD docs.
* Change documentation of all PMDs with common part.

RFC:
* http://dpdk.org/ml/archives/dev/2017-April/062848.html

Shijith Thotton (10):
  doc: add doc to explain compiling and testing of PMD
  doc: refer PMD compile and test section from ark doc
  doc: refer PMD compile and test section from bnx2x doc
  doc: refer PMD compile and test section from cxgbe doc
  doc: refer PMD compile and test section from ena doc
  doc: refer PMD compile and test section from i40e doc
  doc: refer PMD compile and test section from liquidio doc
  doc: refer PMD compile and test section from nfp doc
  doc: refer PMD compile and test section from qede doc
  doc: refer PMD compile and test section from thunderx doc

 doc/guides/nics/ark.rst             |  75 ++++-----------
 doc/guides/nics/bnx2x.rst           | 178 +++++++++--------------------------
 doc/guides/nics/build_and_test.rst  | 179 ++++++++++++++++++++++++++++++++++++
 doc/guides/nics/cxgbe.rst           |  86 +++--------------
 doc/guides/nics/ena.rst             |  69 ++++----------
 doc/guides/nics/i40e.rst            | 108 ++++++++--------------
 doc/guides/nics/index.rst           |   1 +
 doc/guides/nics/liquidio.rst        | 123 +++++++------------------
 doc/guides/nics/nfp.rst             | 141 ++--------------------------
 doc/guides/nics/qede.rst            | 176 +++++++++++++----------------------
 doc/guides/nics/thunderx.rst        | 175 ++++++++++-------------------------
 doc/guides/testpmd_app_ug/index.rst |   2 +
 12 files changed, 466 insertions(+), 847 deletions(-)
 create mode 100644 doc/guides/nics/build_and_test.rst

-- 
1.8.3.1



More information about the dev mailing list