DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ciara Power <ciara.power@intel.com>
To: dev@dpdk.org
Cc: akhil.goyal@nxp.com, declan.doherty@intel.com,
	Ciara Power <ciara.power@intel.com>
Subject: [dpdk-dev] [PATCH 2/2] doc: fix crypto perf script guide
Date: Tue,  2 Feb 2021 11:48:47 +0000	[thread overview]
Message-ID: <20210202114847.3724834-3-ciara.power@intel.com> (raw)
In-Reply-To: <20210202114847.3724834-1-ciara.power@intel.com>

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(-)

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


  parent reply	other threads:[~2021-02-02 11:49 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-02 11:48 [dpdk-dev] [PATCH 0/2] Update doc for crypto perf script Ciara Power
2021-02-02 11:48 ` [dpdk-dev] [PATCH 1/2] doc: update release notes " Ciara Power
2021-02-02 11:48 ` Ciara Power [this message]
2021-02-02 16:58 ` [dpdk-dev] [PATCH v2 0/3] Update crypto perf script and doc Ciara Power
2021-02-02 16:58   ` [dpdk-dev] [PATCH v2 1/3] doc: update release notes for crypto perf script Ciara Power
2021-02-03 10:30     ` Dybkowski, AdamX
2021-02-02 16:58   ` [dpdk-dev] [PATCH v2 2/3] doc: fix crypto perf script guide Ciara Power
2021-02-03 10:30     ` Dybkowski, AdamX
2021-02-02 16:58   ` [dpdk-dev] [PATCH v2 3/3] test/cryptodev: fix handling for config parameters Ciara Power
2021-02-03 10:31     ` Dybkowski, AdamX
2021-02-04 18:27   ` [dpdk-dev] [PATCH v2 0/3] Update crypto perf script and doc 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=20210202114847.3724834-3-ciara.power@intel.com \
    --to=ciara.power@intel.com \
    --cc=akhil.goyal@nxp.com \
    --cc=declan.doherty@intel.com \
    --cc=dev@dpdk.org \
    /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).