[dpdk-dev] [PATCH v5 16/16] docs/qat: refactor docs adding compression guide

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: Trahe, Fiona
> Sent: Wednesday, July 11, 2018 12:57 PM
> To: dev at dpdk.org
> Cc: De Lara Guarch, Pablo <pablo.de.lara.guarch at intel.com>; Trahe, Fiona
> <fiona.trahe at intel.com>; Jozwiak, TomaszX <tomaszx.jozwiak at intel.com>
> Subject: [PATCH v5 16/16] docs/qat: refactor docs adding compression guide
> 
> Extend QAT guide to cover crypto and compression and common information,
> particularly about kernel driver dependency.
> Update release note.
> Update compression feature list for qat.
> 
> 
> Signed-off-by: Fiona Trahe <fiona.trahe at intel.com>
> ---
>  config/common_base                       |   2 +-
>  doc/guides/compressdevs/features/qat.ini |  24 ++++
>  doc/guides/compressdevs/index.rst        |   1 +
>  doc/guides/compressdevs/qat_comp.rst     |  49 +++++++++
>  doc/guides/cryptodevs/qat.rst            | 183 +++++++++++++++++++++----------
>  doc/guides/rel_notes/release_18_08.rst   |   5 +
>  6 files changed, 205 insertions(+), 59 deletions(-)  create mode 100644
> doc/guides/compressdevs/features/qat.ini
>  create mode 100644 doc/guides/compressdevs/qat_comp.rst
> 
> diff --git a/config/common_base b/config/common_base index
> 1e340b4..1380acf 100644
> --- a/config/common_base
> +++ b/config/common_base
> @@ -478,7 +478,7 @@ CONFIG_RTE_LIBRTE_PMD_DPAA_SEC=n
>  CONFIG_RTE_LIBRTE_DPAA_MAX_CRYPTODEV=4
> 
>  #
> -# Compile PMD for QuickAssist based devices
> +# Compile PMD for QuickAssist based devices - see docs for details
>  #
>  CONFIG_RTE_LIBRTE_PMD_QAT=y
>  CONFIG_RTE_LIBRTE_PMD_QAT_SYM=n
> diff --git a/doc/guides/compressdevs/features/qat.ini
> b/doc/guides/compressdevs/features/qat.ini
> new file mode 100644
> index 0000000..0d0e21d
> --- /dev/null
> +++ b/doc/guides/compressdevs/features/qat.ini
> @@ -0,0 +1,24 @@
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +; Supported features of 'QAT' compression driver.
> +;
> +[Features]
> +HW Accelerated      = Y
> +CPU SSE             =
> +CPU AVX             =
> +CPU AVX2            =
> +CPU AVX512          =
> +CPU NEON            =
> +Stateful            =
> +Pass-through        =
> +OOP SGL In SGL Out  =
> +OOP SGL In LB  Out  =
> +OOP LB  In SGL Out  =
> +Deflate             = Y
> +LZS                 =
> +Adler32             = Y
> +Crc32               = Y
> +Adler32&Crc32       = Y
> +Fixed               = Y
> +Dynamic             =

No need to add the features that are not supported here (the ones that do not have "Y").