From: Ciara Power <ciara.power@intel.com>
Date: Tue, 2 Feb 2021 16:58:15 +0000 (+0000)
Subject: doc: fix crypto perf script guide
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=96b32dc7d23ff9bbb3f90a2ea51c587c123448fe;p=dpdk.git

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