From: "Verma, Shally" <Shally.Verma@cavium.com>
To: "De Lara Guarch, Pablo" <pablo.de.lara.guarch@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>,
"Athreya, Narayana Prasad" <NarayanaPrasad.Athreya@cavium.com>,
"Challa, Mahipal" <Mahipal.Challa@cavium.com>,
"Sahu, Sunila" <Sunila.Sahu@cavium.com>,
"Gupta, Ashish" <Ashish.Gupta@cavium.com>
Subject: Re: [dpdk-dev] [PATCH v2 5/5] doc: add ZLIB PMD documentation
Date: Wed, 11 Jul 2018 17:16:25 +0000 [thread overview]
Message-ID: <CY4PR0701MB36343F7010B0AC16FB57A51DF05A0@CY4PR0701MB3634.namprd07.prod.outlook.com> (raw)
In-Reply-To: <E115CCD9D858EF4F90C690B0DCB4D8977F8F7A4B@IRSMSX107.ger.corp.intel.com>
>-----Original Message-----
>From: De Lara Guarch, Pablo [mailto:pablo.de.lara.guarch@intel.com]
>Sent: 11 July 2018 19:32
>To: Verma, Shally <Shally.Verma@cavium.com>
>Cc: dev@dpdk.org; Athreya, Narayana Prasad <NarayanaPrasad.Athreya@cavium.com>; Challa, Mahipal
><Mahipal.Challa@cavium.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>; Gupta, Ashish <Ashish.Gupta@cavium.com>
>Subject: RE: [PATCH v2 5/5] doc: add ZLIB PMD documentation
>
>External Email
>
>> -----Original Message-----
>> From: Shally Verma [mailto:shally.verma@caviumnetworks.com]
>> Sent: Monday, July 2, 2018 5:57 PM
>> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
>> Cc: dev@dpdk.org; pathreya@caviumnetworks.com;
>> mchalla@caviumnetworks.com; Sunila Sahu
>> <sunila.sahu@caviumnetworks.com>; Ashish Gupta
>> <ashish.gupta@caviumnetworks.com>
>> 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 <sunila.sahu@caviumnetworks.com>
>> Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
>> Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
>> ---
>> 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 <sunila.sahu@caviumnetworks.com>
>> 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.
>
>
next prev parent reply other threads:[~2018-07-11 17:17 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-02 16:57 [dpdk-dev] [PATCH v2 0/5] compress: add ZLIB compression PMD Shally Verma
2018-07-02 16:57 ` [dpdk-dev] [PATCH v2 1/5] compress/zlib: add ZLIB PMD support Shally Verma
2018-07-11 10:29 ` De Lara Guarch, Pablo
2018-07-11 12:06 ` De Lara Guarch, Pablo
2018-07-11 12:14 ` De Lara Guarch, Pablo
2018-07-11 12:40 ` Verma, Shally
2018-07-13 15:57 ` De Lara Guarch, Pablo
2018-07-02 16:57 ` [dpdk-dev] [PATCH v2 2/5] compress/zlib: add device setup PMD ops Shally Verma
2018-07-11 11:10 ` De Lara Guarch, Pablo
2018-07-02 16:57 ` [dpdk-dev] [PATCH v2 3/5] compress/zlib: add xform and stream create support Shally Verma
2018-07-11 12:26 ` De Lara Guarch, Pablo
2018-07-11 14:01 ` Verma, Shally
2018-07-02 16:57 ` [dpdk-dev] [PATCH v2 4/5] compress/zlib: add enq deq apis Shally Verma
2018-07-11 13:25 ` De Lara Guarch, Pablo
2018-07-12 5:46 ` Verma, Shally
2018-07-13 15:55 ` De Lara Guarch, Pablo
2018-07-02 16:57 ` [dpdk-dev] [PATCH v2 5/5] doc: add ZLIB PMD documentation Shally Verma
2018-07-11 14:02 ` De Lara Guarch, Pablo
2018-07-11 17:16 ` Verma, Shally [this message]
2018-07-11 20:56 ` De Lara Guarch, Pablo
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CY4PR0701MB36343F7010B0AC16FB57A51DF05A0@CY4PR0701MB3634.namprd07.prod.outlook.com \
--to=shally.verma@cavium.com \
--cc=Ashish.Gupta@cavium.com \
--cc=Mahipal.Challa@cavium.com \
--cc=NarayanaPrasad.Athreya@cavium.com \
--cc=Sunila.Sahu@cavium.com \
--cc=dev@dpdk.org \
--cc=pablo.de.lara.guarch@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).