[PATCH v8 8/8] doc/guides: add documents and release notes for two drivers

[Stephen Hemminger]

On Sun, 29 Sep 2024 23:05:05 +0800
Hanxiao Li <li.hanxiao at zte.com.cn> wrote:

> This patch adds documents and release notes
> about compressdev and cryptodev.
> 
> Signed-off-by: Hanxiao Li <li.hanxiao at zte.com.cn>
> ---
>  doc/guides/compressdevs/features/zsda.ini |  15 ++
>  doc/guides/compressdevs/index.rst         |   1 +
>  doc/guides/compressdevs/zsda.rst          |  45 ++++
>  doc/guides/cryptodevs/features/zsda.ini   |  51 +++++
>  doc/guides/cryptodevs/index.rst           |   1 +
>  doc/guides/cryptodevs/zsda.rst            | 260 ++++++++++++++++++++++
>  doc/guides/rel_notes/release_24_11.rst    |   8 +
>  7 files changed, 381 insertions(+)
>  create mode 100644 doc/guides/compressdevs/features/zsda.ini
>  create mode 100644 doc/guides/compressdevs/zsda.rst
>  create mode 100644 doc/guides/cryptodevs/features/zsda.ini
>  create mode 100644 doc/guides/cryptodevs/zsda.rst
> 
> diff --git a/doc/guides/compressdevs/features/zsda.ini b/doc/guides/compressdevs/features/zsda.ini
> new file mode 100644
> index 0000000000..3b087ea7f9
> --- /dev/null
> +++ b/doc/guides/compressdevs/features/zsda.ini
> @@ -0,0 +1,15 @@
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +; Supported features of 'ZSDA' compression driver.
> +;
> +[Features]
> +HW Accelerated         = Y
> +OOP SGL In SGL Out     = Y
> +OOP SGL In LB  Out     = Y
> +OOP LB  In SGL Out     = Y
> +Deflate                = Y
> +Adler32                = Y
> +Crc32                  = Y
> +Fixed                  = Y
> +Dynamic                = Y
> diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst
> index 87ed4f72a4..bab226ffbc 100644
> --- a/doc/guides/compressdevs/index.rst
> +++ b/doc/guides/compressdevs/index.rst
> @@ -17,3 +17,4 @@ Compression Device Drivers
>      qat_comp
>      uadk
>      zlib
> +    zsda
> diff --git a/doc/guides/compressdevs/zsda.rst b/doc/guides/compressdevs/zsda.rst
> new file mode 100644
> index 0000000000..2d0737e4ba
> --- /dev/null
> +++ b/doc/guides/compressdevs/zsda.rst
> @@ -0,0 +1,45 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2024 ZTE Corporation.
> +
> +ZTE Storage Data Accelerator (ZSDA) Poll Mode Driver
> +=======================================================
> +
> +The ZSDA compression PMD provides poll mode compression & decompression driver
> +support for the following hardware accelerator devices:
> +
> +* ``ZTE Processing accelerators 1cf2``
> +
> +
> +Features
> +--------
> +
> +ZSDA compression PMD has support for:
> +
> +Compression/Decompression algorithm:
> +
> +    * DEFLATE - using Fixed and Dynamic Huffman encoding
> +
> +Checksum generation:
> +
> +    * CRC32, Adler32
> +
> +Huffman code type:
> +
> +* FIXED
> +* DYNAMIC
> +
> +
> +Limitations
> +-----------
> +
> +* Compressdev level 0, no compression, is not supported.
> +* No BSD support as BSD ZSDA kernel driver not available.
> +* Stateful is not supported.
> +
> +
> +Installation
> +------------
> +
> +The ZSDA compression PMD is built by default with a standard DPDK build.
> +
> +It depends on a ZSDA kernel driver, see :ref:`building_zsda`.
> \ No newline at end of file

Fix you editor settings, all files in git should end with a newline.

Did you build the docs after this? Build is failing here.
If you add a new feature it needs to be in default.ini as well.

FAILED: doc/guides/html 
/usr/bin/python3 ../buildtools/call-sphinx-build.py /usr/bin/sphinx-build 24.11.0-rc0 /home/runner/work/dpdk/dpdk/doc/guides /home/runner/work/dpdk/dpdk/build/doc/guides -a -W
Warning generate_overview_table(): Unknown feature 'SM4 XTS' in 'zsda.ini'

Exception occurred: