From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 2E316A04B1 for ; Wed, 23 Sep 2020 15:26:16 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C53F41DD13; Wed, 23 Sep 2020 15:26:10 +0200 (CEST) Received: from mailout1.w1.samsung.com (mailout1.w1.samsung.com [210.118.77.11]) by dpdk.org (Postfix) with ESMTP id AB2CA1DC7C for ; Wed, 23 Sep 2020 15:25:52 +0200 (CEST) Received: from eucas1p2.samsung.com (unknown [182.198.249.207]) by mailout1.w1.samsung.com (KnoxPortal) with ESMTP id 20200923132552euoutp01032fda84bca11e7028675e653e74e9e1~3bI6oqzM41234812348euoutp013 for ; Wed, 23 Sep 2020 13:25:52 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 mailout1.w1.samsung.com 20200923132552euoutp01032fda84bca11e7028675e653e74e9e1~3bI6oqzM41234812348euoutp013 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com; s=mail20170921; t=1600867552; bh=dU7rWktTPIfjQZ7fCAIykFYYMgwWcdJlLIM6bxgVZkM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=e9hcELPHhf0tYm/wT0s50cCZSp3TB+JgqdSureq/9iDgt9c12AaTxH3vwOD7BplBa aCeAOUou4hezoK9fsbQZHRbAyJQR+X4BYoFYpAx09jbExZ7B6+R3HQjK27y0a5rlXo PVxXddTd6TeucC+J7FfpZc6X+6hS3GfO+uiEBgsw= Received: from eusmges2new.samsung.com (unknown [203.254.199.244]) by eucas1p2.samsung.com (KnoxPortal) with ESMTP id 20200923132552eucas1p2e90bb315630d9d1eb37ea82254f063ea~3bI6Z3JxB1223412234eucas1p2R; Wed, 23 Sep 2020 13:25:52 +0000 (GMT) Received: from eucas1p2.samsung.com ( [182.198.249.207]) by eusmges2new.samsung.com (EUCPMTA) with SMTP id A8.84.05997.0EC4B6F5; Wed, 23 Sep 2020 14:25:52 +0100 (BST) Received: from eusmtrp1.samsung.com (unknown [182.198.249.138]) by eucas1p2.samsung.com (KnoxPortal) with ESMTPA id 20200923132551eucas1p214a5f78c61e891c5e7b6cddc038d0e2e~3bI5-iett2291022910eucas1p2l; Wed, 23 Sep 2020 13:25:51 +0000 (GMT) Received: from eusmgms2.samsung.com (unknown [182.198.249.180]) by eusmtrp1.samsung.com (KnoxPortal) with ESMTP id 20200923132551eusmtrp1eaa5cd8ab7c3ecb4c91d3b2fd2bf8ad5~3bI5_-DXL3190431904eusmtrp1J; Wed, 23 Sep 2020 13:25:51 +0000 (GMT) X-AuditID: cbfec7f4-677ff7000000176d-69-5f6b4ce0c461 Received: from eusmtip2.samsung.com ( [203.254.199.222]) by eusmgms2.samsung.com (EUCPMTA) with SMTP id 6E.FA.06017.FDC4B6F5; Wed, 23 Sep 2020 14:25:51 +0100 (BST) Received: from Padamandas.fritz.box (unknown [106.210.88.70]) by eusmtip2.samsung.com (KnoxPortal) with ESMTPA id 20200923132551eusmtip2f7688535bb01670e978cd5c685e3a16f~3bI5WIR2G2716727167eusmtip2g; Wed, 23 Sep 2020 13:25:51 +0000 (GMT) From: Lukasz Wojciechowski To: David Hunt , Bruce Richardson Cc: dev@dpdk.org, l.wojciechow@partner.samsung.com, stable@dpdk.org Date: Wed, 23 Sep 2020 15:25:41 +0200 Message-Id: <20200923132541.21417-9-l.wojciechow@partner.samsung.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200923132541.21417-1-l.wojciechow@partner.samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFnrMIsWRmVeSWpSXmKPExsWy7djP87oPfLLjDc7e5ra4screom/SRyaL d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoLpuU1JzMstQifbsEroyLx36z FhyWqnjz6zxTA+M20S5GTg4JAROJH9c62LsYuTiEBFYwSmza0AjlfGGU2Nr+jhXC+cwoMWH6 c8YuRg6wlr5pfiDdQgLLGSXuXOCEsD8xSlz5rgtiswnYShyZ+ZUVxBYRCJNobt7LAtLKLOAs 8eQrG0hYWMBNonfheiYQm0VAVeJe8wOw6bwCrhL7rrJD3CYvsXrDAWYQmxOo/MOP94wg10gI XGaT6Fh7lBWiyEVi5cRzzBC2sMSr41ugmmUkTk/uYYFo2MYocfX3T6ju/YwS13tXQFVZSxz+ 95sN4jhNifW79CHCjhI7jx9hhniXT+LGW0GQMDOQOWnbdKgwr0RHmxBEtZ7E056pjDBr/6x9 wgJR4iFx8ZY5JACvMkqc/naaeQKj/CyEXQsYGVcxiqeWFuempxYb5aWW6xUn5haX5qXrJefn bmIERv3pf8e/7GDc9SfpEKMAB6MSDy+Hbna8EGtiWXFl7iFGCQ5mJRFep7On44R4UxIrq1KL 8uOLSnNSiw8xSnOwKInzGi96GSskkJ5YkpqdmlqQWgSTZeLglGpgnJTY53dZqbHa5mLs62cs S2UXNkbqZzEm68xkelm2uDXDqIuvqMiWT/qMz526msc9m767sgYs2p6j2fWoOdzeyN9o3yy+ xakHf5hvXspcX17kcmcpm9xx3wu/LSrmlGiGe5UI2rVFzmy8+HvvoqdTjrEf2ClqXXnue9+i tQcDZojUTax0C56uxFKckWioxVxUnAgALRWRifYCAAA= X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFjrGLMWRmVeSWpSXmKPExsVy+t/xe7r3fbLjDV7s1LG4screom/SRyaL d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoPZui/NKSVIWM/OISW6VoQwsj PUNLCz0jE0s9Q2PzWCsjUyV9O5uU1JzMstQifbsEvYyLx36zFhyWqnjz6zxTA+M20S5GDg4J AROJvml+XYxcHEICSxkl3jzpYIKIy0h8uCTQxcgJZApL/LnWxQZR84FR4va604wgCTYBW4kj M7+ygtSLCIRJnFjpDxJmFnCX2LJ4KjOILSzgJtG7cD0TiM0ioCpxr/kBI0g5r4CrxL6r7BDj 5SVWbzgAVs4JVP7hx3tGiFWNjBIb37YxTmDkW8DIsIpRJLW0ODc9t9hIrzgxt7g0L10vOT93 EyMwDLcd+7llB2PXu+BDjAIcjEo8vBy62fFCrIllxZW5hxglOJiVRHidzp6OE+JNSaysSi3K jy8qzUktPsRoCnTURGYp0eR8YIzklcQbmhqaW1gamhubG5tZKInzdggcjBESSE8sSc1OTS1I LYLpY+LglGpgvCTvauZ1WH9mzH3G652+Vae0P3Be9hfd+CFkco7695IFF9V0n68WrOQ7sLFy U5nupztKQn/nuPw15/P1mtmiEP23QVOy+fweVkbl8tkxCdXvHn3cm+UjmhLM+V3707rL16TC 2BNN1ju0BE6tK6pTWfakqlvApmdV6Ru+b56R1Wp9639enduvxFKckWioxVxUnAgA43iJL1kC AAA= X-CMS-MailID: 20200923132551eucas1p214a5f78c61e891c5e7b6cddc038d0e2e X-Msg-Generator: CA Content-Type: text/plain; charset="utf-8" X-RootMTR: 20200923132551eucas1p214a5f78c61e891c5e7b6cddc038d0e2e X-EPHeader: CA CMS-TYPE: 201P X-CMS-RootMailID: 20200923132551eucas1p214a5f78c61e891c5e7b6cddc038d0e2e References: <20200923014713.16932-1-l.wojciechow@partner.samsung.com> <20200923132541.21417-1-l.wojciechow@partner.samsung.com> Subject: [dpdk-stable] [PATCH v3 8/8] distributor: align API documentation with code X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" After introducing burst API there were some artefacts in the API documentation from legacy single API. Also the rte_distributor_poll_pkt() function return values mismatched the implementation. Fixes: c0de0eb82e40 ("distributor: switch over to new API") Cc: david.hunt@intel.com Cc: stable@dpdk.org Signed-off-by: Lukasz Wojciechowski --- lib/librte_distributor/rte_distributor.h | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/lib/librte_distributor/rte_distributor.h b/lib/librte_distributor/rte_distributor.h index 327c0c4ab..a073e6461 100644 --- a/lib/librte_distributor/rte_distributor.h +++ b/lib/librte_distributor/rte_distributor.h @@ -155,7 +155,7 @@ rte_distributor_clear_returns(struct rte_distributor *d); * @param pkts * The mbufs pointer array to be filled in (up to 8 packets) * @param oldpkt - * The previous packet, if any, being processed by the worker + * The previous packets, if any, being processed by the worker * @param retcount * The number of packets being returned * @@ -187,15 +187,15 @@ rte_distributor_return_pkt(struct rte_distributor *d, /** * API called by a worker to request a new packet to process. - * Any previous packet given to the worker is assumed to have completed + * Any previous packets given to the worker are assumed to have completed * processing, and may be optionally returned to the distributor via * the oldpkt parameter. - * Unlike rte_distributor_get_pkt_burst(), this function does not wait for a - * new packet to be provided by the distributor. + * Unlike rte_distributor_get_pkt(), this function does not wait for + * new packets to be provided by the distributor. * - * NOTE: after calling this function, rte_distributor_poll_pkt_burst() should - * be used to poll for the packet requested. The rte_distributor_get_pkt_burst() - * API should *not* be used to try and retrieve the new packet. + * NOTE: after calling this function, rte_distributor_poll_pkt() should + * be used to poll for the packets requested. The rte_distributor_get_pkt() + * API should *not* be used to try and retrieve the new packets. * * @param d * The distributor instance to be used @@ -213,9 +213,9 @@ rte_distributor_request_pkt(struct rte_distributor *d, unsigned int count); /** - * API called by a worker to check for a new packet that was previously + * API called by a worker to check for new packets that were previously * requested by a call to rte_distributor_request_pkt(). It does not wait - * for the new packet to be available, but returns NULL if the request has + * for the new packets to be available, but returns if the request has * not yet been fulfilled by the distributor. * * @param d @@ -227,8 +227,9 @@ rte_distributor_request_pkt(struct rte_distributor *d, * The array of mbufs being given to the worker * * @return - * The number of packets being given to the worker thread, zero if no - * packet is yet available. + * The number of packets being given to the worker thread, + * -1 if no packets are yet available (burst API - RTE_DIST_ALG_BURST) + * 0 if no packets are yet available (legacy single API - RTE_DIST_ALG_SINGLE) */ int rte_distributor_poll_pkt(struct rte_distributor *d, -- 2.17.1