[dpdk-dev,2/4] doc: document new nb-desc parameter for test-crypto-perf app

Message ID 5333960e82770fd1fc5d0441767922b5aa8c31e3.1503566892.git.anatoly.burakov@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Pablo de Lara Guarch
Headers

Checks

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

Commit Message

Anatoly Burakov Aug. 24, 2017, 10:48 a.m. UTC
  Signed-off-by: Burakov, Anatoly <anatoly.burakov@intel.com>
---
 doc/guides/tools/cryptoperf.rst | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

De Lara Guarch, Pablo Sept. 4, 2017, 1:12 p.m. UTC | #1
> -----Original Message-----
> From: Burakov, Anatoly
> Sent: Thursday, August 24, 2017 11:48 AM
> To: dev@dpdk.org
> Cc: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Doherty,
> Declan <declan.doherty@intel.com>; Burakov, Anatoly
> <anatoly.burakov@intel.com>
> Subject: [PATCH 2/4] doc: document new nb-desc parameter for test-
> crypto-perf app

Since this is related to the previous patch and it is a small addition,
merge it with the previous patch.

> 
> Signed-off-by: Burakov, Anatoly <anatoly.burakov@intel.com>
> ---
>  doc/guides/tools/cryptoperf.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/tools/cryptoperf.rst
> b/doc/guides/tools/cryptoperf.rst index 457f817..985848b 100644
> --- a/doc/guides/tools/cryptoperf.rst
> +++ b/doc/guides/tools/cryptoperf.rst
> @@ -325,6 +325,10 @@ The following are the appication command-line
> options:
> 
>          Set the size of digest.
> 
> +* ``--desc-nb <n>``
> +
> +        Set default number of descriptors in cryptodev.

I think this should be reworded, as it is not setting the default number of descriptor (which is 2048),
but it is setting the number of descriptors for each crypto device.  

> +
>  * ``--csv-friendly``
> 
>          Enable test result output CSV friendly rather than human friendly.
> --
> 2.7.4
  

Patch

diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst
index 457f817..985848b 100644
--- a/doc/guides/tools/cryptoperf.rst
+++ b/doc/guides/tools/cryptoperf.rst
@@ -325,6 +325,10 @@  The following are the appication command-line options:
 
         Set the size of digest.
 
+* ``--desc-nb <n>``
+
+        Set default number of descriptors in cryptodev.
+
 * ``--csv-friendly``
 
         Enable test result output CSV friendly rather than human friendly.