[v8,5/7] doc: update dpdk-test-compress-perf description

Message ID 20190708181619.8028-6-arturx.trybula@intel.com
State Accepted, archived
Delegated to: akhil goyal
Headers show
Series
  • add multiple cores feature to test-compress-perf
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Artur Trybula July 8, 2019, 6:16 p.m.
From: Tomasz Jozwiak <tomaszx.jozwiak@intel.com>

This patch updates dpdk-test-compress-perf documentation.

Signed-off-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com>
Acked-by: Artur Trybula <arturx.trybula@intel.com>
---
 doc/guides/tools/comp_perf.rst | 34 +++++++++++++++++++++++++++++++---
 1 file changed, 31 insertions(+), 3 deletions(-)

Patch

diff --git a/doc/guides/tools/comp_perf.rst b/doc/guides/tools/comp_perf.rst
index 52869c18c..71eef1821 100644
--- a/doc/guides/tools/comp_perf.rst
+++ b/doc/guides/tools/comp_perf.rst
@@ -6,7 +6,9 @@  dpdk-test-compress-perf Tool
 
 The ``dpdk-test-compress-perf`` tool is a Data Plane Development Kit (DPDK)
 utility that allows measuring performance parameters of PMDs available in the
-compress tree. The tool reads the data from a file (--input-file),
+compress tree. User can use multiple cores to run tests on but only
+one type of compression PMD can be measured during single application
+execution. The tool reads the data from a file (--input-file),
 dumps all the file into a buffer and fills out the data of input mbufs,
 which are passed to compress device with compression operations.
 Then, the output buffers are fed into the decompression stage, and the resulting
@@ -26,9 +28,35 @@  Limitations
 
 * Stateful operation is not supported in this version.
 
+EAL Options
+~~~~~~~~~~~
+
+The following are the EAL command-line options that can be used in conjunction
+with the ``dpdk-test-compress-perf`` application.
+See the DPDK Getting Started Guides for more information on these options.
+
+*   ``-c <COREMASK>`` or ``-l <CORELIST>``
+
+	Set the hexadecimal bitmask of the cores to run on. The corelist is a
+	list cores to use.
+
+.. Note::
+
+	One lcore is needed for process admin, tests are run on all other cores.
+	To run tests on two lcores, three lcores must be passed to the tool.
+
+*   ``-w <PCI>``
+
+	Add a PCI device in white list.
+
+*   ``--vdev <driver><id>``
+
+	Add a virtual device.
+
+Appication Options
+~~~~~~~~~~~~~~~~~~
 
-Command line options
---------------------
+ ``--ptest [benchmark/verify]``: set test type (default: benchmark)
 
  ``--driver-name NAME``: compress driver to use