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

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

[Arek Kusztal]

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

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

[Ali Alnubani]

Thanks for the fix Arek.

> -----Original Message-----
> From: Arek Kusztal <arkadiuszx.kusztal@intel.com>
> Sent: Monday, August 31, 2020 8:23 AM
> To: bluca@debian.org; fiona.trahe@intel.com; Ali Alnubani
> <alialnu@nvidia.com>
> Cc: Arek Kusztal <arkadiuszx.kusztal@intel.com>; stable@dpdk.org
> Subject: [19.11] doc: fix doc build after qat threshold patch
> 
> 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>
> ---

Tested-by: Ali Alnubani <alialnu@nvidia.com>

Regards,
Ali

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

[Luca Boccassi]

On Mon, 2020-08-31 at 07:25 +0000, Ali Alnubani wrote:
> Thanks for the fix Arek.
> 
> > -----Original Message-----
> > From: Arek Kusztal <arkadiuszx.kusztal@intel.com>
> > Sent: Monday, August 31, 2020 8:23 AM
> > To: bluca@debian.org; fiona.trahe@intel.com; Ali Alnubani
> > <alialnu@nvidia.com>
> > Cc: Arek Kusztal <arkadiuszx.kusztal@intel.com>; stable@dpdk.org
> > Subject: [19.11] doc: fix doc build after qat threshold patch
> > 
> > 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>
> > ---
> 
> Tested-by: Ali Alnubani <alialnu@nvidia.com>
> 
> Regards,
> Ali

Thanks, applied and pushed.

-- 
Kind regards,
Luca Boccassi