From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 0579A1B4FD for ; Wed, 11 Jul 2018 16:02:31 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 11 Jul 2018 07:02:30 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,338,1526367600"; d="scan'208";a="53592022" Received: from irsmsx153.ger.corp.intel.com ([163.33.192.75]) by fmsmga007.fm.intel.com with ESMTP; 11 Jul 2018 07:02:29 -0700 Received: from irsmsx107.ger.corp.intel.com ([169.254.10.193]) by IRSMSX153.ger.corp.intel.com ([169.254.9.210]) with mapi id 14.03.0319.002; Wed, 11 Jul 2018 15:02:28 +0100 From: "De Lara Guarch, Pablo" To: Shally Verma CC: "dev@dpdk.org" , "pathreya@caviumnetworks.com" , "mchalla@caviumnetworks.com" , Sunila Sahu , Ashish Gupta Thread-Topic: [PATCH v2 5/5] doc: add ZLIB PMD documentation Thread-Index: AQHUEiXbE3O0KkXdwEyJANNbKf/MZKSKEXVg Date: Wed, 11 Jul 2018 14:02:27 +0000 Message-ID: References: <1530550631-22841-1-git-send-email-shally.verma@caviumnetworks.com> <1530550631-22841-6-git-send-email-shally.verma@caviumnetworks.com> In-Reply-To: <1530550631-22841-6-git-send-email-shally.verma@caviumnetworks.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiZTY0MjYyZDktMDgwOS00NDcwLThhM2UtNzBhYjZiMDYzMTRhIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiMGllYlwvMWJhNnRiUGx4S1hWYVNUWjVUNkVBKzRXcVlcL21oUngwUUJrS1wvQWxHeHRQK1RNc3lTajBmQ09WMlhZRiJ9 x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.0.200.100 dlp-reaction: no-action x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v2 5/5] doc: add ZLIB PMD documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 11 Jul 2018 14:02:32 -0000 > -----Original Message----- > From: Shally Verma [mailto:shally.verma@caviumnetworks.com] > Sent: Monday, July 2, 2018 5:57 PM > To: De Lara Guarch, Pablo > Cc: dev@dpdk.org; pathreya@caviumnetworks.com; > mchalla@caviumnetworks.com; Sunila Sahu > ; Ashish Gupta > > Subject: [PATCH v2 5/5] doc: add ZLIB PMD documentation >=20 Better change title to "add ZLIB PMD guide", to avoid duplication. > add zlib pmd feature specification and overview documentation >=20 > Signed-off-by: Sunila Sahu > Signed-off-by: Shally Verma > Signed-off-by: Ashish Gupta > --- > MAINTAINERS | 2 + > doc/guides/compressdevs/features/zlib.ini | 22 ++++++++++ > doc/guides/compressdevs/zlib.rst | 68 > +++++++++++++++++++++++++++++++ > 3 files changed, 92 insertions(+) >=20 > 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 > F: drivers/compress/zlib/ > +F: doc/guides/compressdevs/zlib.rst > +F: doc/guides/compressdevs/features/zlib.ini >=20 > 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 =3D > +CPU SSE =3D > +CPU AVX =3D > +CPU AVX2 =3D > +CPU AVX512 =3D > +CPU NEON =3D > +Stateful =3D > +By-Pass =3D > +Chained mbufs =3D > +Deflate =3D Y > +LZS =3D > +Adler32 =3D > +Crc32 =3D > +Adler32&Crc32 =3D > +Fixed =3D Y > +Dynamic =3D Y No need to include the features that the PMD does not support (plus, some of those names have been changed). > 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. > +* 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 bl= ank line; unexpected unindent. doc/guides/compressdevs/zlib.rst:42: WARNING: Block quote ends without a bl= ank 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 bl= ank line; unexpected unindent. doc/guides/compressdevs/zlib.rst: WARNING: document isn't included in any t= octree > + > +* Once downloaded, the user needs to build the library. > + > +* make can be used to install the library on their system, before build= ing > DPDK:: > + > + make > + sudo make install This is not required for packages in distros. I assume that this is then fo= r building from source code. In that case, I think it would be good to differentiate between the two sce= narios.