diff mbox series

[v2,2/3] doc: fix crypto perf script guide

Message ID 20210202165816.3767724-3-ciara.power@intel.com (mailing list archive)
State Accepted, archived
Delegated to: akhil goyal
Headers
Series Update crypto perf script and doc |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Power, Ciara Feb. 2, 2021, 4:58 p.m. UTC 
  The guide for using the crypto perf graphing script had some incorrect
indentation, unnecessary blank lines, and a missing argument in one of
the usage examples. These are corrected in this patch.

Fixes: f400e0b82bf1 ("app/crypto-perf: add script to graph perf results")

Signed-off-by: Ciara Power <ciara.power@intel.com>
---
 doc/guides/tools/cryptoperf.rst | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

Comments

Dybkowski, AdamX Feb. 3, 2021, 10:30 a.m. UTC | #1 
> -----Original Message-----
> From: Power, Ciara <ciara.power@intel.com>
> Sent: Tuesday, 2 February, 2021 17:58
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Doherty, Declan <declan.doherty@intel.com>;
> Dybkowski, AdamX <adamx.dybkowski@intel.com>; Power, Ciara
> <ciara.power@intel.com>
> Subject: [PATCH v2 2/3] doc: fix crypto perf script guide
> 
> The guide for using the crypto perf graphing script had some incorrect
> indentation, unnecessary blank lines, and a missing argument in one of the
> usage examples. These are corrected in this patch.
> 
> Fixes: f400e0b82bf1 ("app/crypto-perf: add script to graph perf results")
> 
> Signed-off-by: Ciara Power <ciara.power@intel.com>

Acked-by: Adam Dybkowski <adamx.dybkowski@intel.com>
diff mbox series

Patch

diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst
index 86c5a8aa16..7479af60a9 100644
--- a/doc/guides/tools/cryptoperf.rst
+++ b/doc/guides/tools/cryptoperf.rst
@@ -545,8 +545,7 @@  The following are the application optional command-line options:
 
 * ``-h, --help``
 
-    Display usage information and quit
-
+  Display usage information and quit.
 
 * ``-f <file_path>, --file-path <file_path>``
 
@@ -555,8 +554,8 @@  The following are the application optional command-line options:
 
   .. code-block:: console
 
-     ./dpdk-graph-crypto-perf -f <build_dir>/app/dpdk-test-crypto-perf
-
+     ./dpdk-graph-crypto-perf <config_file> \
+         -f <build_dir>/app/dpdk-test-crypto-perf
 
 * ``-t <test_suite_list>, --test-suites <test_suite_list>``
 
@@ -574,7 +573,6 @@  The following are the application optional command-line options:
 
      ./dpdk-graph-crypto-perf configs/crypto-perf-aesni-mb -t throughput latency
 
-
 * ``-o <output_path>, --output-path <output_path>``
 
   Specify directory to use for output files.
@@ -584,7 +582,6 @@  The following are the application optional command-line options:
 
      ./dpdk-graph-crypto-perf <config_file> -o <output_dir>
 
-
 * ``-v, --verbose``
 
   Enable verbose output. This displays ``dpdk-test-crypto-perf`` app output in real-time.