> -----Original Message----- > From: Daly, Lee > Sent: Tuesday, April 17, 2018 2:36 PM > To: dev@dpdk.org > Cc: De Lara Guarch, Pablo <pablo.de.lara.gua...@intel.com>; Tucker, Greg B > <greg.b.tuc...@intel.com>; Jain, Deepak K <deepak.k.j...@intel.com>; Trahe, > Fiona <fiona.tr...@intel.com>; Daly, Lee <lee.d...@intel.com> > Subject: [PATCH v3 10/11] compress/isal: add generic compression driver docs > > Signed-off-by: Lee Daly <lee.d...@intel.com>
... > 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 = > +CPU SSE = > +CPU AVX = > +CPU AVX2 = > +CPU AVX512 = > +CPU NEON = > +Stateful = > +By-Pass = > +Chained mbufs = > +; > +; Supported algorithims of the 'ISA-L' compression driver. This file is generic for all PMDs, so remove the ISAL reference (same applicable below). > +; > +[ALGORITHIM] > +Deflate = > +LZS = > +; > +; Supported checksums of the 'ISA-L' compression driver. > +; > +[CHECKSUMS] > +Adler32 = > +Crc32 = > +Adler32&Crc32 = > +; > +; Supported huffman codes of the 'ISA-L' compression driver. > +; > +[HUFFMAN CODES] > +Default = No need to add default here. > +Fixed = > +Dynamic = > +Semi-Dynamic = 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 > +=================================================== > + > +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 generates 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 encoding. Then, maybe it is just better to have all these sections in the FEATURES section, to build a single table. Lastly, you need to add this file in the .gitignore file, to avoid adding it into git. > @@ -0,0 +1,81 @@ > + > +.. raw:: html
