From mboxrd@z Thu Jan  1 00:00:00 1970
From: "Varghese, Vipin" <vipin.varghese@intel.com>
Subject: Re: [PATCH v3 3/5] doc/guides/tools: add doc files
Date: Fri, 23 Nov 2018 14:52:40 +0000
Message-ID: <4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2C1ADF@BGSMSX101.gar.corp.intel.com>
References: <1541151842-8746-1-git-send-email-tomaszx.jozwiak@intel.com>
 <1542978409-28668-1-git-send-email-tomaszx.jozwiak@intel.com>
 <1542978409-28668-4-git-send-email-tomaszx.jozwiak@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
To: "Jozwiak, TomaszX" <tomaszx.jozwiak@intel.com>, "dev@dpdk.org"
 <dev@dpdk.org>, "Trahe, Fiona" <fiona.trahe@intel.com>, "Jozwiak, TomaszX"
 <tomaszx.jozwiak@intel.com>, "Shally.Verma@cavium.com"
 <Shally.Verma@cavium.com>, "akhil.goyal@nxp.com" <akhil.goyal@nxp.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mga04.intel.com (mga04.intel.com [192.55.52.120])
 by dpdk.org (Postfix) with ESMTP id 8F9A31B59C
 for <dev@dpdk.org>; Fri, 23 Nov 2018 15:52:46 +0100 (CET)
In-Reply-To: <1542978409-28668-4-git-send-email-tomaszx.jozwiak@intel.com>
Content-Language: en-US
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

Hi Tomasz,

<snipped>

> +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
> +

Suggestion to remove extra '=3D'

> +The ``dpdk-test-compress-perf`` tool is a Data Plane Development Kit
> +(DPDK) utility that allows measuring performance parameters of PMDs

Is this test application or utility like procinfo or pdump?

> +available in the compress tree. The application 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 compressio=
n
> operations.
> +Then, the output buffers are fed into the decompression stage, and the
> +resulting data is compared against the original data (verification
> +phase). After that, a number of iterations are performed, compressing
> +first and decompressing later, to check the throughput rate (showing
> +cycles/iteration, cycles/Byte and Gbps, for compression and decompressio=
n).
> +
> +
> +Limitations
> +~~~~~~~~~~~
> +

Suggestion to remove extra '~'

> +* Only supports the fixed compression and stateless operation.
> +

Is the limitation of the application that it will not cover stateful?

> +Command line options
> +--------------------
> +
> + ``--driver-name NAME``: compress driver to use
> +
> + ``--input-file NAME``: file to compress and decompress
> +
> + ``--extended-input-sz N``: extend file data up to this size (default:
> + no extension)
> +
> + ``--seg-sz N``: size of segment to store the data (default: 2048)
> +
> + ``--burst-sz N``: compress operation burst size
> +
> + ``--pool-sz N``: mempool size for compress operations/mbufs (default:
> + 8192)
> +
> + ``--max-num-sgl-segs N``: maximum number of segments for each mbuf
> + (default: 16)
> +
> + ``--num-iter N``: number of times the file will be
> + compressed/decompressed (default: 10000)
> +
> + ``--operation [comp/decomp/comp_and_decomp]``: perform test on
> + compression, decompression or both operations
> +
> + ``--huffman-enc [fixed/default]``: Huffman encoding (default: fixed)
> +
> + ``--compress-level N``: compression level, which could be a single
> + value, list or range (default: range between 1 and 9)
> +
> + ``--window-sz N``: base two log value of compression window size
> + (default: max supported by PMD)
> +
> + ``-h``: prints this help
> +
> +
> +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
> +

Does this application only run with ISAL? If yes will it be ok to mention t=
his in limitation?

> +
> +Running the Application
> +-----------------------
> +
> +The tool application has a number of command line options. Here is the
> sample command line:
> +

Here we are using 'tool application'. Would either one of application or ut=
ility state the right usage?