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 094CFA04B5 for ; Wed, 23 Sep 2020 03:47:43 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 1649F1DBC0; Wed, 23 Sep 2020 03:47:39 +0200 (CEST) Received: from mailout2.w1.samsung.com (mailout2.w1.samsung.com [210.118.77.12]) by dpdk.org (Postfix) with ESMTP id 0CCA61DB50 for ; Wed, 23 Sep 2020 03:47:25 +0200 (CEST) Received: from eucas1p1.samsung.com (unknown [182.198.249.206]) by mailout2.w1.samsung.com (KnoxPortal) with ESMTP id 20200923014724euoutp02507381d2fe2e140016b6bd2608550cb8~3RnFAlN0z2715027150euoutp02H for ; Wed, 23 Sep 2020 01:47:24 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 mailout2.w1.samsung.com 20200923014724euoutp02507381d2fe2e140016b6bd2608550cb8~3RnFAlN0z2715027150euoutp02H DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com; s=mail20170921; t=1600825644; bh=dU7rWktTPIfjQZ7fCAIykFYYMgwWcdJlLIM6bxgVZkM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=u+aZPeOWwNh8/8nVLDoBkr1JLWj/SnGeZTW3Fw4gTIFyfas0kJ1Nsh4qkprS3gJei zE4DsKzNw24dDqEe1FEVDcyvljqfn5NFVhSdsuGKiGNWocGq/SKdiGTRh4e/gxUP3b /NPF0UPIYA0QZmkZgFdfAsjtgvHqf0UX435jYuqI= Received: from eusmges1new.samsung.com (unknown [203.254.199.242]) by eucas1p2.samsung.com (KnoxPortal) with ESMTP id 20200923014724eucas1p24c86413284c0670dcfcb3a26fe08afcf~3RnE1fNpP2914429144eucas1p2E; Wed, 23 Sep 2020 01:47:24 +0000 (GMT) Received: from eucas1p2.samsung.com ( [182.198.249.207]) by eusmges1new.samsung.com (EUCPMTA) with SMTP id E5.6D.06456.C29AA6F5; Wed, 23 Sep 2020 02:47:24 +0100 (BST) Received: from eusmtrp2.samsung.com (unknown [182.198.249.139]) by eucas1p1.samsung.com (KnoxPortal) with ESMTPA id 20200923014724eucas1p13d3c0428a15bea26def7a4343251e4e4~3RnEfaSAn1605716057eucas1p1D; Wed, 23 Sep 2020 01:47:24 +0000 (GMT) Received: from eusmgms1.samsung.com (unknown [182.198.249.179]) by eusmtrp2.samsung.com (KnoxPortal) with ESMTP id 20200923014724eusmtrp27ead09e9cb58862d6701900d865cdcea~3RnEe289A2054820548eusmtrp2T; Wed, 23 Sep 2020 01:47:24 +0000 (GMT) X-AuditID: cbfec7f2-809ff70000001938-e2-5f6aa92cd366 Received: from eusmtip1.samsung.com ( [203.254.199.221]) by eusmgms1.samsung.com (EUCPMTA) with SMTP id 55.9A.06314.C29AA6F5; Wed, 23 Sep 2020 02:47:24 +0100 (BST) Received: from Padamandas.fritz.box (unknown [106.210.88.70]) by eusmtip1.samsung.com (KnoxPortal) with ESMTPA id 20200923014723eusmtip1705f8e76d12beca0cd9574735c241ded~3RnD3fDSd1064810648eusmtip1w; Wed, 23 Sep 2020 01:47:23 +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 03:47:13 +0200 Message-Id: <20200923014713.16932-9-l.wojciechow@partner.samsung.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200923014713.16932-1-l.wojciechow@partner.samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFnrKIsWRmVeSWpSXmKPExsWy7djP87o6K7PiDY5/U7K4screom/SRyaL d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoLpuU1JzMstQifbsEroyLx36z FhyWqnjz6zxTA+M20S5GDg4JAROJ1e9duhi5OIQEVjBK9B85zQrhfGGUWDF9JjOE85lRYs2P 1WxdjJxgHUsaj0JVLWeUeHT+GjuE84lR4kHbD0aQKjYBW4kjM7+ygtgiAmESzc17WUD2MQs4 Szz5CjZIWMBN4s2tJrByFgFVibPLLjGDlPAKuEq8O88DsUteYvWGA2BhTqDyp//kQTZJCFxm k1h5ehoTRI2LxK+3HSwQtrDEq+Nb2CFsGYn/O+czQTRsY5S4+vsnI4Szn1Hieu8KqCpricP/ frNB3KYpsX6XPkTYUaJ56RtGSBDxSdx4KwgSZgYyJ22bzgwR5pXoaBOCqNaTeNozlRFm7Z+1 T6DO8ZBYuu0PGyR0rjJKvLp1g30Co/wshGULGBlXMYqnlhbnpqcWG+allusVJ+YWl+al6yXn 525iBEb+6X/HP+1g/Hop6RCjAAejEg/viyeZ8UKsiWXFlbmHGCU4mJVEeJ3Ono4T4k1JrKxK LcqPLyrNSS0+xCjNwaIkzmu86GWskEB6YklqdmpqQWoRTJaJg1OqgXGjZr7RycM/FnFM2fZQ +NuzPQteLkxa3n74de2xbfcMTZo/s339uNHpl5RHhbS169SO+ZpCf2dOeFL9aoqecMMmi0n/ tPO2WvxTWfnnndljbutI043zzqT80qnduHGn+fPzLJJLH8bwp5Sb5tme/i6taFC5Yt6izx85 TGK6VVd5/JrwSfSrimKBEktxRqKhFnNRcSIAVKm7vfgCAAA= X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFjrGLMWRmVeSWpSXmKPExsVy+t/xu7o6K7PiDa5/47a4screom/SRyaL d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoPZui/NKSVIWM/OISW6VoQwsj PUNLCz0jE0s9Q2PzWCsjUyV9O5uU1JzMstQifbsEvYyLx36zFhyWqnjz6zxTA+M20S5GTg4J AROJJY1HWbsYuTiEBJYyStx+fZi9i5EDKCEj8eGSAESNsMSfa11sEDUfGCXuPnnHDJJgE7CV ODLzKytIvYhAmMSJlf4gYWYBd4kti6eClQgLuEm8udXECGKzCKhKnF12iRmknFfAVeLdeR6I 8fISqzccAAtzApU//ScPsamRUWLGwtfsExj5FjAyrGIUSS0tzk3PLTbUK07MLS7NS9dLzs/d xAgMw23Hfm7ewXhpY/AhRgEORiUe3hdPMuOFWBPLiitzDzFKcDArifA6nT0dJ8SbklhZlVqU H19UmpNafIjRFOimicxSosn5wBjJK4k3NDU0t7A0NDc2NzazUBLn7RA4GCMkkJ5YkpqdmlqQ WgTTx8TBKdXA2DF9zTYv/fWnsnmiWt+3mWgwvU+VD9x+x2TBhWV71yTck38nU/Qvvarv/ZLp lx7reP+qFtn3fFHZZ3mXP2Zmqpvu1pjyyfsEvPXRab+RP794S9Azpif2Vd8PrskL2Cj2quvr /WfLZXcH1IXcjhR6IL3q0cKKDiGV7o+5flUXnQ9JZLe+XVgQpsRSnJFoqMVcVJwIALJyzB9Z AgAA X-CMS-MailID: 20200923014724eucas1p13d3c0428a15bea26def7a4343251e4e4 X-Msg-Generator: CA Content-Type: text/plain; charset="utf-8" X-RootMTR: 20200923014724eucas1p13d3c0428a15bea26def7a4343251e4e4 X-EPHeader: CA CMS-TYPE: 201P X-CMS-RootMailID: 20200923014724eucas1p13d3c0428a15bea26def7a4343251e4e4 References: <20200915193449.13310-1-l.wojciechow@partner.samsung.com> <20200923014713.16932-1-l.wojciechow@partner.samsung.com> Subject: [dpdk-stable] [PATCH v2 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