From mboxrd@z Thu Jan 1 00:00:00 1970 From: "De Lara Guarch, Pablo" Subject: Re: [PATCH v3 10/11] compress/isal: add generic compression driver docs Date: Tue, 24 Apr 2018 10:47:58 +0000 Message-ID: References: <1523038388-29964-1-git-send-email-lee.daly@intel.com> <1523972132-6894-1-git-send-email-lee.daly@intel.com> <1523972132-6894-11-git-send-email-lee.daly@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Cc: "Tucker, Greg B" , "Jain, Deepak K" , "Trahe, Fiona" To: "Daly, Lee" , "dev@dpdk.org" Return-path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 414742C8 for ; Tue, 24 Apr 2018 12:48:02 +0200 (CEST) In-Reply-To: <1523972132-6894-11-git-send-email-lee.daly@intel.com> Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > -----Original Message----- > From: Daly, Lee > Sent: Tuesday, April 17, 2018 2:36 PM > To: dev@dpdk.org > Cc: De Lara Guarch, Pablo ; Tucker, Greg = B > ; Jain, Deepak K ; Trah= e, > Fiona ; Daly, Lee > Subject: [PATCH v3 10/11] compress/isal: add generic compression driver d= ocs >=20 > Signed-off-by: Lee Daly ... > b/doc/guides/compressdevs/features/default.ini > new file mode 100644 > index 0000000..b7fe1e1 > --- /dev/null > +++ b/doc/guides/compressdevs/features/default.ini > @@ -0,0 +1,42 @@ > +; > +; Features of a default compression driver. > +; > +; This file defines the features that are valid for inclusion in ; the > +other driver files and also the order that they appear in ; the > +features table in the documentation. > +; > +[FEATURES] > +HW Accelerated =3D > +CPU SSE =3D > +CPU AVX =3D > +CPU AVX2 =3D > +CPU AVX512 =3D > +CPU NEON =3D > +Stateful =3D > +By-Pass =3D > +Chained mbufs =3D > +; > +; Supported algorithims of the 'ISA-L' compression driver. This file is generic for all PMDs, so remove the ISAL reference (same appli= cable below). > +; > +[ALGORITHIM] > +Deflate =3D > +LZS =3D > +; > +; Supported checksums of the 'ISA-L' compression driver. > +; > +[CHECKSUMS] > +Adler32 =3D > +Crc32 =3D > +Adler32&Crc32 =3D > +; > +; Supported huffman codes of the 'ISA-L' compression driver. > +; > +[HUFFMAN CODES] > +Default =3D No need to add default here. > +Fixed =3D > +Dynamic =3D > +Semi-Dynamic =3D Semi-dynamic Huffman coding is not in the API, so remove it. > +; > +; Supported others of the 'ISA-L' compression driver. > +; > +[OTHERS] Remove this section if it is going to be empty. ... > +++ b/doc/guides/compressdevs/overview.rst > @@ -0,0 +1,12 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2018 Intel Corporation. > + > +Compression Device Supported Functionality Matrices > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D > + > +Supported Feature Flags > +----------------------- > + > +.. _table_compression_pmd_features: > + > +.. include:: overview_feature_table.txt > diff --git a/doc/guides/compressdevs/overview_feature_table.txt > b/doc/guides/compressdevs/overview_feature_table.txt > new file mode 100644 > index 0000000..b775124 > --- /dev/null > +++ b/doc/guides/compressdevs/overview_feature_table.txt This document gets generated with Sphinx. It parses the .ini files and gene= rates it. Look at how is done for cryptodev, in the setup function in doc/guides/conf= .py,. You should also extend the table for algorithm, checksum and Huffman encod= ing. Then, maybe it is just better to have all these sections in the FEATURES se= ction, to build a single table. Lastly, you need to add this file in the .gitignore file, to avoid adding i= t into git. > @@ -0,0 +1,81 @@ > + > +.. raw:: html