[dpdk-dev] [PATCH v4 3/5] doc/guides/tools: add doc files

[Jozwiak, TomaszX]

> -----Original Message-----
> From: Varghese, Vipin
> Sent: Friday, November 23, 2018 4:00 PM
> To: Jozwiak, TomaszX <tomaszx.jozwiak at intel.com>; dev at dpdk.org; Trahe,
> Fiona <fiona.trahe at intel.com>; Jozwiak, TomaszX
> <tomaszx.jozwiak at intel.com>; Shally.Verma at cavium.com;
> akhil.goyal at nxp.com
> Subject: RE: [dpdk-dev] [PATCH v4 3/5] doc/guides/tools: add doc files
> 
> Apologies Tomasz, I shared my comments in v3. sharing for v4
> 
> >  Crypto performance test application
> >  M: Declan Doherty <declan.doherty at intel.com>
> >  F: app/test-crypto-perf/
> > diff --git a/doc/guides/rel_notes/release_18_11.rst
> > b/doc/guides/rel_notes/release_18_11.rst
> > index 32ff0e5..d44cf30 100644
> > --- a/doc/guides/rel_notes/release_18_11.rst
> > +++ b/doc/guides/rel_notes/release_18_11.rst
> > @@ -328,6 +328,11 @@ New Features
> >    additional command-line parameter values from the
> "DPDK_TEST_PARAMS"
> >    environment variable to make this application easier to use.
> >
> > +* **Added a compression performance test tool.**
> 
> It is mentioned as test application above, here test tool. Should we make this
> synced?

Will sync

> 
> >
> >  API Changes
> >  -----------
> > diff --git a/doc/guides/tools/comp_perf.rst
> > b/doc/guides/tools/comp_perf.rst new file mode 100644 index
> > 0000000..1428348
> > --- /dev/null
> > +++ b/doc/guides/tools/comp_perf.rst
> > @@ -0,0 +1,75 @@
> > +..  SPDX-License-Identifier: BSD-3-Clause
> > +    Copyright(c) 2018 Intel Corporation.
> > +
> > +dpdk-test-compress-perf Application
> > +===================================
> 
> Should we remove extra '='?

It's ok. Please take a look at console output or count the chars 



> 
> > +
> > +The ``dpdk-test-compress-perf`` tool is a Data Plane Development Kit
> > +(DPDK) utility that allows measuring performance parameters of PMDs
> 
> Should we keep this as test application? Or is this an utility like pdump or
> procinfo?
> 
> > +
> > +
> > +Limitations
> > +~~~~~~~~~~~
> 
> Extra '~'?

No. It's ok. Please take a look at console output or count the chars


> 
> > +
> > +* Only supports the fixed compression and stateless operation.
> 
> Is 'stateful' not supported a limitation rather than supporting stateless?

In this initial version we support only stateless operation. Will be updated in the future versions.


> 
> > +
> > +Command line options
> > +--------------------
> > +
> 
> Missing '-'

No. It's ok. Please take a look at console output or count the chars

> 
> > +Compiling the Application
> > +-------------------------
> > +
> > +**Step 1: PMD setting**
> > +
> > +The ``dpdk-test-compress-perf`` tool depends on compression device
> > +drivers PMD which can be disabled by default in the build
> > +configuration file
> > ``common_base``.
> > +The compression device drivers PMD which should be tested can be
> > +enabled
> > by setting::
> > +
> > +   CONFIG_RTE_LIBRTE_PMD_ISAL=y
> 
> Does this test application other PMD? If not can we cover this in limitation?

Should be eg.:


> 
> > +
> > +
> > +Running the Application
> > +-----------------------
> > +
> > +The tool application has a number of command line options. Here is
> > +the
> > sample command line:
> 
> Do we need to reword 'tool application' to either 'test application' or 'test
> utility'?

Will sync this.

> 
> > +
> > +.. code-block:: console
> > +
> > +   ./build/app/dpdk-test-compress-perf  -l 4 -- --driver-name
> > + compress_qat --
> > input-file test.txt --seg-sz 8192
> > +    --compress-level 1:1:9 --num-iter 10 --extended-input-sz 1048576
> > + --max-num-sgl-segs 16 --huffman-enc fixed
> > +
> > diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst
> > index a6e2c4c..24235ba 100644
> > --- a/doc/guides/tools/index.rst
> > +++ b/doc/guides/tools/index.rst
> > @@ -42,3 +42,4 @@ DPDK Tools User Guides
> >      testbbdev
> >      cryptoperf
> >      testeventdev
> > +    comp_perf
> > --
> > 2.7.4




Thx, Tomek