patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Arek Kusztal <arkadiuszx.kusztal@intel.com>
To: bluca@debian.org, fiona.trahe@intel.com, alialnu@nvidia.com
Cc: Arek Kusztal <arkadiuszx.kusztal@intel.com>, stable@dpdk.org
Subject: [dpdk-stable] [19.11] doc: fix doc build after qat threshold patch
Date: Mon, 31 Aug 2020 07:22:55 +0200	[thread overview]
Message-ID: <20200831052255.962-1-arkadiuszx.kusztal@intel.com> (raw)

This patch fixes problem with too short underline and
unexpected indentation in doc build.

Fixes: 3cbb62874f53 ("crypto/qat: add minimum enq threshold")
Cc: stable@dpdk.org

Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
---
 doc/guides/cryptodevs/qat.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index aa3cdcf..c8bc514 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -274,7 +274,7 @@ allocated while for GEN1 devices, 12 buffers are allocated, plus 1472 bytes over
 
 
 Running QAT PMD with minimum threshold for burst size
-~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If only a small number or packets can be enqueued. Each enqueue causes an expensive MMIO write.
 These MMIO write occurrences can be optimised by setting any of the following parameters
@@ -284,8 +284,11 @@ These MMIO write occurrences can be optimised by setting any of the following pa
 When any of these parameters is set rte_cryptodev_enqueue_burst function will
 return 0 (thereby avoiding an MMIO) if the device is congested and number of packets
 possible to enqueue is smaller.
-To use this feature the user must set the parameter on process start as a device additional parameter:
- .example: '-w 03:01.1,qat_sym_enq_threshold=32,qat_comp_enq_threshold=16'
+
+To use this feature the user must set the parameter on process start as a device additional parameter::
+
+      example: -w 03:01.1,qat_sym_enq_threshold=32,qat_comp_enq_threshold=16
+
 All parameters can be used with the same device regardless of order. Parameters are separated
 by comma. When the same parameter is used more than once first occurrence of the parameter
 is used.
-- 
2.1.0


             reply	other threads:[~2020-08-31  5:26 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-31  5:22 Arek Kusztal [this message]
2020-08-31  7:25 ` Ali Alnubani
2020-08-31  9:12   ` Luca Boccassi

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=20200831052255.962-1-arkadiuszx.kusztal@intel.com \
    --to=arkadiuszx.kusztal@intel.com \
    --cc=alialnu@nvidia.com \
    --cc=bluca@debian.org \
    --cc=fiona.trahe@intel.com \
    --cc=stable@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).