[dpdk-stable] [19.11] doc: fix doc build after qat threshold patch

Arek Kusztal arkadiuszx.kusztal at intel.com
Mon Aug 31 07:22:55 CEST 2020


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

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

Signed-off-by: Arek Kusztal <arkadiuszx.kusztal at 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



More information about the stable mailing list