diff mbox series

[v2,6/8] doc/qat: update kernel dependency section

Message ID 1533833430-29134-7-git-send-email-fiona.trahe@intel.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
Headers
Series doc/qat: clarify build config options |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Fiona Trahe Aug. 9, 2018, 4:50 p.m. UTC 
  Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 doc/guides/cryptodevs/qat.rst | 12 +++---------
 1 file changed, 3 insertions(+), 9 deletions(-)

Comments

Thomas Monjalon Aug. 9, 2018, 7:36 p.m. UTC | #1 
09/08/2018 18:50, Fiona Trahe:
> --- a/doc/guides/cryptodevs/qat.rst
> +++ b/doc/guides/cryptodevs/qat.rst
> @@ -120,10 +120,8 @@ Quick instructions are as follows:
>  	make
>  
>  
> -.. _qat_kernel_installation:
> -
>  Dependency on the QAT kernel driver
> ------------------------------------
> +~~~~~~~~~~~~~~~~~~~~~~~~

Strange, why changing the underline to make it shorter?
Fiona Trahe Aug. 10, 2018, 7:45 a.m. UTC | #2 
Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, August 9, 2018 8:36 PM
> To: Trahe, Fiona <fiona.trahe@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX
> <tomaszx.jozwiak@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v2 6/8] doc/qat: update kernel dependency section
> 
> 09/08/2018 18:50, Fiona Trahe:
> > --- a/doc/guides/cryptodevs/qat.rst
> > +++ b/doc/guides/cryptodevs/qat.rst
> > @@ -120,10 +120,8 @@ Quick instructions are as follows:
> >  	make
> >
> >
> > -.. _qat_kernel_installation:
> > -
> >  Dependency on the QAT kernel driver
> > ------------------------------------
> > +~~~~~~~~~~~~~~~~~~~~~~~~
> 
> Strange, why changing the underline to make it shorter?
> 
The intent was to correct the indent level, I didn't intend to make it shorter.
But I don't know why checkpatch didn't catch this as it did warn of too short underlines in other places.
I'll fix in a v3
diff mbox series

Patch

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index e6d78ac16..2f233ec9d 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -120,10 +120,8 @@  Quick instructions are as follows:
 	make
 
 
-.. _qat_kernel_installation:
-
 Dependency on the QAT kernel driver
------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 To use the QAT PMD an SRIOV-enabled QAT kernel driver is required. The VF
 devices created and initialised by this driver will be used by the QAT PMD.
@@ -132,12 +130,8 @@  Instructions for installation are below, but first an explanation of the
 relationships between the PF/VF devices and the PMDs visible to
 DPDK applications.
 
-
-Acceleration services - cryptography and compression - are provided to DPDK
-applications via PMDs which register to implement the corresponding
-cryptodev and compressdev APIs.
-
-Each QuickAssist VF device can expose one cryptodev PMD and/or one compressdev PMD.
+Each QuickAssist PF device exposes a number of VF devices. Each VF device can
+enable one cryptodev PMD and/or one compressdev PMD.
 These QAT PMDs share the same underlying device and pci-mgmt code, but are
 enumerated independently on their respective APIs and appear as independent
 devices to applications.