DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Varghese, Vipin" <vipin.varghese@intel.com>
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>
Subject: Re: [dpdk-dev] [PATCH v4 3/5] doc/guides/tools: add doc files
Date: Fri, 23 Nov 2018 15:00:12 +0000	[thread overview]
Message-ID: <4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2C1AF9@BGSMSX101.gar.corp.intel.com> (raw)
In-Reply-To: <1542983269-30093-4-git-send-email-tomaszx.jozwiak@intel.com>

Apologies Tomasz, I shared my comments in v3. sharing for v4

>  Crypto performance test application
>  M: Declan Doherty <declan.doherty@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?

> 
>  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 '='?

> +
> +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 '~'?

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

Is 'stateful' not supported a limitation rather than supporting stateless?

> +
> +Command line options
> +--------------------
> +

Missing '-'

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

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

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

  reply	other threads:[~2018-11-23 15:00 UTC|newest]

Thread overview: 76+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-01 13:27 [dpdk-dev] [PATCH 0/3] app: add initial version of compress-perf Tomasz Jozwiak
2018-10-01 13:27 ` [dpdk-dev] [PATCH 1/3] app/compress-perf: add parser Tomasz Jozwiak
2018-10-01 13:27 ` [dpdk-dev] [PATCH 2/3] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-10-12 10:15   ` Verma, Shally
2018-10-15 15:10     ` Daly, Lee
2018-10-16  5:18       ` Verma, Shally
2018-10-17 14:33       ` Trahe, Fiona
2018-10-17 15:42         ` Verma, Shally
2018-10-17 16:45           ` Trahe, Fiona
2018-10-17 16:47             ` Verma, Shally
2018-11-30 14:43               ` Jozwiak, TomaszX
2018-12-02  6:39                 ` Verma, Shally
2018-12-05  8:51                   ` Jozwiak, TomaszX
2018-11-02  9:59     ` Jozwiak, TomaszX
2018-11-05  8:34       ` Verma, Shally
2018-11-06  8:04         ` Jozwiak, TomaszX
2018-11-06  8:15           ` Verma, Shally
2018-11-06  9:05             ` Jozwiak, TomaszX
2018-11-06 15:39               ` Verma, Shally
2018-11-07 10:18                 ` Jozwiak, TomaszX
2018-11-10  0:54                   ` Trahe, Fiona
2018-11-12  4:45                     ` Verma, Shally
2018-10-01 13:27 ` [dpdk-dev] [PATCH 3/3] doc/guides/tools: add doc file Tomasz Jozwiak
2018-10-16  9:26   ` Kovacevic, Marko
2018-11-02  9:43 ` [dpdk-dev] [PATCH v2 0/3] add initial version of compress-perf Tomasz Jozwiak
2018-11-02  9:44   ` [dpdk-dev] [PATCH v2 1/3] app/compress-perf: add parser Tomasz Jozwiak
2018-11-05  8:40     ` Verma, Shally
2018-11-06  8:30       ` Jozwiak, TomaszX
2018-11-06  8:32         ` Verma, Shally
2018-11-02  9:44   ` [dpdk-dev] [PATCH v2 2/3] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-11-05  8:56     ` Verma, Shally
2018-11-06  8:49       ` Jozwiak, TomaszX
2018-11-06 15:37         ` Verma, Shally
2018-11-07 10:14           ` Jozwiak, TomaszX
2018-11-02  9:44   ` [dpdk-dev] [PATCH v2 3/3] doc/guides/tools: add doc files Tomasz Jozwiak
2018-11-05  8:57     ` Verma, Shally
2018-11-06  8:51       ` Jozwiak, TomaszX
2018-11-02 11:04   ` [dpdk-dev] [PATCH v2 0/3] add initial version of compress-perf Bruce Richardson
2018-11-02 11:12     ` Jozwiak, TomaszX
2018-11-23 13:06   ` [dpdk-dev] [PATCH v3 0/5] " Tomasz Jozwiak
2018-11-23 13:06     ` [dpdk-dev] [PATCH v3 1/5] app/compress-perf: add parser Tomasz Jozwiak
2018-11-23 13:06     ` [dpdk-dev] [PATCH v3 2/5] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-11-23 13:06     ` [dpdk-dev] [PATCH v3 3/5] doc/guides/tools: add doc files Tomasz Jozwiak
2018-11-23 14:52       ` Varghese, Vipin
2018-11-23 14:59         ` Jozwiak, TomaszX
2018-11-23 13:06     ` [dpdk-dev] [PATCH v3 4/5] app/compress-perf: add dynamic compression test Tomasz Jozwiak
2018-11-23 13:06     ` [dpdk-dev] [PATCH v3 5/5] app/compress-perf: code refactoring Tomasz Jozwiak
2018-11-23 14:27     ` [dpdk-dev] [PATCH v4 0/5] add initial version of compress-perf Tomasz Jozwiak
2018-11-23 14:27       ` [dpdk-dev] [PATCH v4 1/5] app/compress-perf: add parser Tomasz Jozwiak
2018-11-23 15:10         ` Varghese, Vipin
2018-11-23 15:24           ` Bruce Richardson
2018-11-23 15:42             ` Jozwiak, TomaszX
2018-11-23 14:27       ` [dpdk-dev] [PATCH v4 2/5] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-11-23 14:27       ` [dpdk-dev] [PATCH v4 3/5] doc/guides/tools: add doc files Tomasz Jozwiak
2018-11-23 15:00         ` Varghese, Vipin [this message]
2018-11-23 15:12           ` Jozwiak, TomaszX
2018-11-23 15:26             ` Varghese, Vipin
2018-11-23 14:27       ` [dpdk-dev] [PATCH v4 4/5] app/compress-perf: add dynamic compression test Tomasz Jozwiak
2018-11-23 14:27       ` [dpdk-dev] [PATCH v4 5/5] app/compress-perf: code refactoring Tomasz Jozwiak
2018-12-05  8:47       ` [dpdk-dev] [PATCH v5 0/5] add initial version of compress-perf Tomasz Jozwiak
2018-12-05  8:47         ` [dpdk-dev] [PATCH v5 1/5] app/compress-perf: add parser Tomasz Jozwiak
2018-12-05  8:47         ` [dpdk-dev] [PATCH v5 2/5] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-12-05  8:47         ` [dpdk-dev] [PATCH v5 3/5] doc/guides/tools: add doc files Tomasz Jozwiak
2018-12-05  8:47         ` [dpdk-dev] [PATCH v5 4/5] app/compress-perf: add dynamic compression test Tomasz Jozwiak
2018-12-05  8:47         ` [dpdk-dev] [PATCH v5 5/5] app/compress-perf: code refactoring Tomasz Jozwiak
2018-12-05 15:37         ` [dpdk-dev] [PATCH v5 0/5] add initial version of compress-perf Daly, Lee
2018-12-12 11:54         ` [dpdk-dev] [PATCH v6 " Tomasz Jozwiak
2018-12-17 11:11           ` Verma, Shally
2018-12-12 12:08         ` Tomasz Jozwiak
2018-12-12 12:08           ` [dpdk-dev] [PATCH v6 1/5] app/compress-perf: add parser Tomasz Jozwiak
2018-12-12 12:08           ` [dpdk-dev] [PATCH v6 2/5] app/compress-perf: add performance measurement Tomasz Jozwiak
2018-12-12 12:08           ` [dpdk-dev] [PATCH v6 3/5] doc/guides/tools: add doc files Tomasz Jozwiak
2018-12-12 12:08           ` [dpdk-dev] [PATCH v6 4/5] app/compress-perf: add dynamic compression test Tomasz Jozwiak
2018-12-12 12:08           ` [dpdk-dev] [PATCH v6 5/5] app/compress-perf: code refactoring Tomasz Jozwiak
2018-12-14 19:24           ` [dpdk-dev] [PATCH v6 0/5] add initial version of compress-perf Trahe, Fiona
2018-12-18 10:28           ` Akhil Goyal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2C1AF9@BGSMSX101.gar.corp.intel.com \
    --to=vipin.varghese@intel.com \
    --cc=Shally.Verma@cavium.com \
    --cc=akhil.goyal@nxp.com \
    --cc=dev@dpdk.org \
    --cc=fiona.trahe@intel.com \
    --cc=tomaszx.jozwiak@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).