From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6DE29A04AB for ; Mon, 31 Aug 2020 07:26:34 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 5CC2DCF3; Mon, 31 Aug 2020 07:26:34 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 38717CF3 for ; Mon, 31 Aug 2020 07:26:33 +0200 (CEST) IronPort-SDR: RPTALm08hQ+ppdaDeldmT7UV3PGjPpiNUTGqzftiBaIjm10URU9QurRjlCRvvuCsaKiCPQ2+GB SEhNddfl8kCA== X-IronPort-AV: E=McAfee;i="6000,8403,9729"; a="218461069" X-IronPort-AV: E=Sophos;i="5.76,374,1592895600"; d="scan'208";a="218461069" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 30 Aug 2020 22:26:31 -0700 IronPort-SDR: NWNhngZdE4eyfdr2JFHJV5QGui9ZJQcuQj54FpJhyKxFNkAoZLJYXhwN+J0z01QY9aiXTH7lyl iqGRrZIIRvEA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.76,374,1592895600"; d="scan'208";a="314237140" Received: from akusztax-mobl1.ger.corp.intel.com ([10.104.121.110]) by orsmga002.jf.intel.com with ESMTP; 30 Aug 2020 22:26:29 -0700 From: Arek Kusztal To: bluca@debian.org, fiona.trahe@intel.com, alialnu@nvidia.com Cc: Arek Kusztal , stable@dpdk.org Date: Mon, 31 Aug 2020 07:22:55 +0200 Message-Id: <20200831052255.962-1-arkadiuszx.kusztal@intel.com> X-Mailer: git-send-email 2.28.0.windows.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-stable] [19.11] doc: fix doc build after qat threshold patch X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" 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 --- 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