From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Jozwiak, TomaszX" Subject: Re: [PATCH v4 3/5] doc/guides/tools: add doc files Date: Fri, 23 Nov 2018 15:12:15 +0000 Message-ID: References: <1542978409-28668-1-git-send-email-tomaszx.jozwiak@intel.com> <1542983269-30093-1-git-send-email-tomaszx.jozwiak@intel.com> <1542983269-30093-4-git-send-email-tomaszx.jozwiak@intel.com> <4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2C1AF9@BGSMSX101.gar.corp.intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable To: "Varghese, Vipin" , "dev@dpdk.org" , "Trahe, Fiona" , "Shally.Verma@cavium.com" , "akhil.goyal@nxp.com" Return-path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 405723421 for ; Fri, 23 Nov 2018 16:12:21 +0100 (CET) In-Reply-To: <4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2C1AF9@BGSMSX101.gar.corp.intel.com> Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > -----Original Message----- > From: Varghese, Vipin > Sent: Friday, November 23, 2018 4:00 PM > To: Jozwiak, TomaszX ; dev@dpdk.org; Trahe, > Fiona ; Jozwiak, TomaszX > ; Shally.Verma@cavium.com; > akhil.goyal@nxp.com > Subject: RE: [dpdk-dev] [PATCH v4 3/5] doc/guides/tools: add doc files >=20 > Apologies Tomasz, I shared my comments in v3. sharing for v4 >=20 > > Crypto performance test application > > M: Declan Doherty > > 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.** >=20 > It is mentioned as test application above, here test tool. Should we make= this > synced? Will sync >=20 > > > > 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 > > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >=20 > Should we remove extra '=3D'? It's ok. Please take a look at console output or count the chars=20 >=20 > > + > > +The ``dpdk-test-compress-perf`` tool is a Data Plane Development Kit > > +(DPDK) utility that allows measuring performance parameters of PMDs >=20 > Should we keep this as test application? Or is this an utility like pdump= or > procinfo? >=20 > > + > > + > > +Limitations > > +~~~~~~~~~~~ >=20 > Extra '~'? No. It's ok. Please take a look at console output or count the chars >=20 > > + > > +* Only supports the fixed compression and stateless operation. >=20 > Is 'stateful' not supported a limitation rather than supporting stateless= ? In this initial version we support only stateless operation. Will be update= d in the future versions. >=20 > > + > > +Command line options > > +-------------------- > > + >=20 > Missing '-' No. It's ok. Please take a look at console output or count the chars >=20 > > +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=3Dy >=20 > Does this test application other PMD? If not can we cover this in limitat= ion? Should be eg.: >=20 > > + > > + > > +Running the Application > > +----------------------- > > + > > +The tool application has a number of command line options. Here is > > +the > > sample command line: >=20 > Do we need to reword 'tool application' to either 'test application' or '= test > utility'? Will sync this. >=20 > > + > > +.. 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