>-----Original Message-----
>From: De Lara Guarch, Pablo [mailto:[email protected]]
>Sent: 11 July 2018 19:32
>To: Verma, Shally <[email protected]>
>Cc: [email protected]; Athreya, Narayana Prasad
><[email protected]>; Challa, Mahipal
><[email protected]>; Sahu, Sunila <[email protected]>; Gupta,
>Ashish <[email protected]>
>Subject: RE: [PATCH v2 5/5] doc: add ZLIB PMD documentation
>
>External Email
>
>> -----Original Message-----
>> From: Shally Verma [mailto:[email protected]]
>> Sent: Monday, July 2, 2018 5:57 PM
>> To: De Lara Guarch, Pablo <[email protected]>
>> Cc: [email protected]; [email protected];
>> [email protected]; Sunila Sahu
>> <[email protected]>; Ashish Gupta
>> <[email protected]>
>> Subject: [PATCH v2 5/5] doc: add ZLIB PMD documentation
>>
>
>Better change title to "add ZLIB PMD guide", to avoid duplication.
>
>> add zlib pmd feature specification and overview documentation
>>
>> Signed-off-by: Sunila Sahu <[email protected]>
>> Signed-off-by: Shally Verma <[email protected]>
>> Signed-off-by: Ashish Gupta <[email protected]>
>> ---
>> MAINTAINERS | 2 +
>> doc/guides/compressdevs/features/zlib.ini | 22 ++++++++++
>> doc/guides/compressdevs/zlib.rst | 68
>> +++++++++++++++++++++++++++++++
>> 3 files changed, 92 insertions(+)
>>
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index 448bbe1..1c217b0 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -854,6 +854,8 @@ F: doc/guides/compressdevs/features/isal.ini
>> ZLIB
>> M: Sunila Sahu <[email protected]>
>> F: drivers/compress/zlib/
>> +F: doc/guides/compressdevs/zlib.rst
>> +F: doc/guides/compressdevs/features/zlib.ini
>>
>> Eventdev Drivers
>> ----------------
>> diff --git a/doc/guides/compressdevs/features/zlib.ini
>> b/doc/guides/compressdevs/features/zlib.ini
>> new file mode 100644
>> index 0000000..bdc0fc4
>> --- /dev/null
>> +++ b/doc/guides/compressdevs/features/zlib.ini
>> @@ -0,0 +1,22 @@
>> +;
>> +; Refer to default.ini for the full list of available PMD features.
>> +;
>> +; Supported features of 'ZLIB' compression driver.
>> +;
>> +[Features]
>> +HW Accelerated =
>> +CPU SSE =
>> +CPU AVX =
>> +CPU AVX2 =
>> +CPU AVX512 =
>> +CPU NEON =
>> +Stateful =
>> +By-Pass =
>> +Chained mbufs =
>> +Deflate = Y
>> +LZS =
>> +Adler32 =
>> +Crc32 =
>> +Adler32&Crc32 =
>> +Fixed = Y
>> +Dynamic = Y
>
>No need to include the features that the PMD does not support
>(plus, some of those names have been changed).
>
You mean remove entry with empty values like >> +Crc32 =
>> diff --git a/doc/guides/compressdevs/zlib.rst
>> b/doc/guides/compressdevs/zlib.rst
>> new file mode 100644
>> index 0000000..7dd5c74
>> --- /dev/null
>> +++ b/doc/guides/compressdevs/zlib.rst
>
>...
>
>> +
>> +Installation
>> +------------
>> +
>> +* To build DPDK with ZLIB library, the user is required to download the
>> ``libz``
>
>Zlib?
Library is available with name libz .
Thanks
Shally
>
>> library.
>> +* Use following command for installation.
>> +
>> +* For Fedora users ::
>> + yum install zlib-devel
>> +* For ubuntu users ::
>
>Ubuntu
>
>> + apt-get install zlib1g-dev
>
>I am seeing a build error because of these lines:
>
>doc/guides/compressdevs/zlib.rst:41: WARNING: Literal block expected; none
>found.
>doc/guides/compressdevs/zlib.rst:41: WARNING: Bullet list ends without a blank
>line; unexpected unindent.
>doc/guides/compressdevs/zlib.rst:42: WARNING: Block quote ends without a blank
>line; unexpected unindent.
>doc/guides/compressdevs/zlib.rst:43: WARNING: Literal block expected; none
>found.
>doc/guides/compressdevs/zlib.rst:43: WARNING: Bullet list ends without a blank
>line; unexpected unindent.
>doc/guides/compressdevs/zlib.rst: WARNING: document isn't included in any
>toctree
>
>> +
>> +* Once downloaded, the user needs to build the library.
>> +
>> +* make can be used to install the library on their system, before building
>> DPDK::
>> +
>> + make
>> + sudo make install
>
>This is not required for packages in distros. I assume that this is then for
>building from source code.
>In that case, I think it would be good to differentiate between the two
>scenarios.
>
>
