From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM01-SN1-obe.outbound.protection.outlook.com (mail-sn1nam01on0065.outbound.protection.outlook.com [104.47.32.65]) by dpdk.org (Postfix) with ESMTP id CE3AD1B296 for ; Wed, 11 Jul 2018 19:17:44 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=YrMzYQur0Ox1u0NBPubKeOTIOyICSDxBUKeAeX+O1/E=; b=h+m5PBtA+PHFupQ02OqJxU2YEvL05alz1o3zUT7yMVb9g7ebnJlVEr6zBq5W8mBjuQFWfOrUOZjZNQyY3uXJSRPivUYAEHN8MXR3W9N1oo2Bms6uiPosjqgz4KPUxgN8KLE4r6uH2ZuvqYddguCGxd0nMfsCEUVW7tl51tyfQ3c= Received: from CY4PR0701MB3634.namprd07.prod.outlook.com (52.132.101.164) by CY4PR0701MB3827.namprd07.prod.outlook.com (52.132.102.161) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.930.20; Wed, 11 Jul 2018 17:16:26 +0000 Received: from CY4PR0701MB3634.namprd07.prod.outlook.com ([fe80::f0d4:1828:37f5:5927]) by CY4PR0701MB3634.namprd07.prod.outlook.com ([fe80::f0d4:1828:37f5:5927%2]) with mapi id 15.20.0930.022; Wed, 11 Jul 2018 17:16:25 +0000 From: "Verma, Shally" To: "De Lara Guarch, Pablo" CC: "dev@dpdk.org" , "Athreya, Narayana Prasad" , "Challa, Mahipal" , "Sahu, Sunila" , "Gupta, Ashish" Thread-Topic: [PATCH v2 5/5] doc: add ZLIB PMD documentation Thread-Index: AQHUGR/SOzB0SmaYCE2xmKEQNqJFoKSKFOLQ Date: Wed, 11 Jul 2018 17:16:25 +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: Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: spf=none (sender IP is ) smtp.mailfrom=Shally.Verma@cavium.com; x-originating-ip: [117.98.204.228] x-ms-publictraffictype: Email x-microsoft-exchange-diagnostics: 1; CY4PR0701MB3827; 7:/a/y5uO8YtoDvCGrTQjpdDslK9BDXDNeo7k0wmLkoj+8wV0UTjkDFFZ4pnhzCitUI8/3MbKxklCtJb0kLsb0+StLrIVQ+Wts250xDBtGxN5GM83UFRaT1e6fTlOYFOL8wmBkv6JSULVaGRKiSfx1wZk2asVm4zzop28nsoOvXD6DNCfgq+Zaatd5bA5XmveUajCStqQfX68nY++LrUIyDyU7sv2ha9JqHn6/vvBlP9mU0Cu+k/DAXF7y7rqBrX0B x-ms-exchange-antispam-srfa-diagnostics: SOS;SOR; x-forefront-antispam-report: SFV:SKI; SCL:-1; SFV:NSPM; SFS:(10009020)(136003)(366004)(39860400002)(346002)(376002)(396003)(189003)(199004)(13464003)(54906003)(5660300001)(9686003)(55016002)(7736002)(86362001)(6116002)(316002)(6436002)(305945005)(186003)(3846002)(26005)(2906002)(6246003)(102836004)(229853002)(5250100002)(53936002)(68736007)(486006)(97736004)(107886003)(4326008)(74316002)(575784001)(25786009)(106356001)(81156014)(81166006)(14454004)(8676002)(478600001)(72206003)(105586002)(14444005)(7696005)(6506007)(53546011)(76176011)(2900100001)(11346002)(99286004)(33656002)(446003)(256004)(66066001)(8936002)(6916009)(476003)(217873001); DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR0701MB3827; H:CY4PR0701MB3634.namprd07.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A:1; x-ms-office365-filtering-correlation-id: 1825d8a8-6d8e-4311-47fb-08d5e7520854 x-microsoft-antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989117)(5600053)(711020)(4534165)(4627221)(201703031133081)(201702281549075)(8990107)(2017052603328)(7153060)(7193020); SRVR:CY4PR0701MB3827; x-ms-traffictypediagnostic: CY4PR0701MB3827: x-microsoft-antispam-prvs: x-exchange-antispam-report-test: UriScan:(228905959029699); x-ms-exchange-senderadcheck: 1 x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(10201501046)(93006095)(93001095)(3002001)(3231311)(944501410)(52105095)(149027)(150027)(6041310)(20161123562045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123564045)(20161123560045)(20161123558120)(6072148)(201708071742011)(7699016); SRVR:CY4PR0701MB3827; BCL:0; PCL:0; RULEID:; SRVR:CY4PR0701MB3827; x-forefront-prvs: 0730093765 received-spf: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) x-microsoft-antispam-message-info: Ag2h/7Xc7bCrYdVb2ZSoDuuZa6PJzbAgH+J7n61FRA4uDkQQc8zDDm9Gs0oO9RSyk4UPSyVTag7GYLR7oOnDSfhHlS+lUe5fSZa3i3BUMCNTRTK0zFoqzDuhP/azDwVViGB/5VmCp1D0hkNKUL4sSw8gLIU2aDL1Dm6CywFckwws6kZ/+Fwt9HHUsJikdOC+gwaixddbuvnXgGge5j6CUTYzsXp96gGFWwjt+LEpLkZLAwXk0YyUJaJLNc1BWRWVVPaUWBfgzj6uRVETg23Ct3pdQQFPD38uAgH0JEnDud6cDzj9QSZDsQxarmI18+Ipb0QF2z/yWu7C6Kbnu/v1sc7O8qkAAMqLadpqyRkIEnM= spamdiagnosticoutput: 1:99 spamdiagnosticmetadata: NSPM Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-OriginatorOrg: cavium.com X-MS-Exchange-CrossTenant-Network-Message-Id: 1825d8a8-6d8e-4311-47fb-08d5e7520854 X-MS-Exchange-CrossTenant-originalarrivaltime: 11 Jul 2018 17:16:25.5243 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR0701MB3827 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 17:17:45 -0000 >-----Original Message----- >From: De Lara Guarch, Pablo [mailto:pablo.de.lara.guarch@intel.com] >Sent: 11 July 2018 19:32 >To: Verma, Shally >Cc: dev@dpdk.org; Athreya, Narayana Prasad ; Challa, Mahipal >; Sahu, Sunila ; Gupta,= Ashish >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 >> Cc: dev@dpdk.org; pathreya@caviumnetworks.com; >> mchalla@caviumnetworks.com; Sunila Sahu >> ; Ashish Gupta >> >> 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 >> 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(+) >> >> 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 >> >> 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). > You mean remove entry with empty values like >> +Crc32 =3D >> 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 b= lank line; unexpected unindent. >doc/guides/compressdevs/zlib.rst:42: WARNING: Block quote ends without a b= lank 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 b= lank 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 buil= ding >> DPDK:: >> + >> + make >> + sudo make install > >This is not required for packages in distros. I assume that this is then f= or building from source code. >In that case, I think it would be good to differentiate between the two sc= enarios. > >