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 87CFCA04C0 for ; Sat, 26 Sep 2020 00:43:01 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 70E9D1EA72; Sat, 26 Sep 2020 00:42:42 +0200 (CEST) Received: from mailout1.w1.samsung.com (mailout1.w1.samsung.com [210.118.77.11]) by dpdk.org (Postfix) with ESMTP id 84C261E9EE for ; Sat, 26 Sep 2020 00:42:25 +0200 (CEST) Received: from eucas1p1.samsung.com (unknown [182.198.249.206]) by mailout1.w1.samsung.com (KnoxPortal) with ESMTP id 20200925224224euoutp014db64755239f50c444e091c7e4613610~4KBZvUJYX2821028210euoutp01D for ; Fri, 25 Sep 2020 22:42:24 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 mailout1.w1.samsung.com 20200925224224euoutp014db64755239f50c444e091c7e4613610~4KBZvUJYX2821028210euoutp01D DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com; s=mail20170921; t=1601073744; bh=dU7rWktTPIfjQZ7fCAIykFYYMgwWcdJlLIM6bxgVZkM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=fPYwsLZXhvuFvCa2aaOn9v1+Jz/T7b9wgXhQ6q6O7aCErVkGtBCkDm0EFfNO3Z+BG 2I9kWfi3HPYWer8TBkv1f25GmU2VFiBuP1t/UCHKU5m4o1Csbj/JHwduc2UcRCthTM l52OtNpYzbr5SBdSKM4gQPzbqLnM9wKl6/j7yEW8= Received: from eusmges2new.samsung.com (unknown [203.254.199.244]) by eucas1p1.samsung.com (KnoxPortal) with ESMTP id 20200925224223eucas1p1f793de5f97c20e5f499cf9f08bab9f3e~4KBYvPITq3102531025eucas1p1s; Fri, 25 Sep 2020 22:42:23 +0000 (GMT) Received: from eucas1p1.samsung.com ( [182.198.249.206]) by eusmges2new.samsung.com (EUCPMTA) with SMTP id 05.DF.05997.F427E6F5; Fri, 25 Sep 2020 23:42:23 +0100 (BST) Received: from eusmtrp1.samsung.com (unknown [182.198.249.138]) by eucas1p1.samsung.com (KnoxPortal) with ESMTPA id 20200925224222eucas1p1b10891c21bfef6784777526af4443dde~4KBXpCqA10081500815eucas1p1H; Fri, 25 Sep 2020 22:42:22 +0000 (GMT) Received: from eusmgms1.samsung.com (unknown [182.198.249.179]) by eusmtrp1.samsung.com (KnoxPortal) with ESMTP id 20200925224222eusmtrp1b240f1c66b69193a29891ce2cfcd93cb~4KBXod2A01720917209eusmtrp1-; Fri, 25 Sep 2020 22:42:22 +0000 (GMT) X-AuditID: cbfec7f4-677ff7000000176d-75-5f6e724f68d9 Received: from eusmtip2.samsung.com ( [203.254.199.222]) by eusmgms1.samsung.com (EUCPMTA) with SMTP id 2F.3C.06314.D427E6F5; Fri, 25 Sep 2020 23:42:22 +0100 (BST) Received: from localhost.localdomain (unknown [106.210.88.70]) by eusmtip2.samsung.com (KnoxPortal) with ESMTPA id 20200925224221eusmtip2ffdc7618af8634266d81621bd80484d8~4KBXEA1wY1081510815eusmtip25; Fri, 25 Sep 2020 22:42:21 +0000 (GMT) From: Lukasz Wojciechowski To: David Hunt , Bruce Richardson Cc: dev@dpdk.org, l.wojciechow@partner.samsung.com, stable@dpdk.org Date: Sat, 26 Sep 2020 00:42:09 +0200 Message-Id: <20200925224209.12173-9-l.wojciechow@partner.samsung.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200925224209.12173-1-l.wojciechow@partner.samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFnrOIsWRmVeSWpSXmKPExsWy7djPc7r+RXnxBjdm8FvcWGVv0TfpI5PF u0/bmSye9axjtPjX8YfdgdXj14KlrB6L97xk8jj4bg9TAHMUl01Kak5mWWqRvl0CV8bFY79Z Cw5LVbz5dZ6pgXGbaBcjJ4eEgInEguMfmbsYuTiEBFYwShx98ZQNwvnCKPH49SQo5zOjxMMl f1lgWh60vGaBSCxnlFj8u4kZrmr9oZlsIFVsArYSR2Z+ZQWxRQTCJJqb9wJ1cHAwCzhLPPkK ViIs4Cbx7d0DRhCbRUBVYvnJV2DlvAKuEjM2nGSGWCYvsXrDATCbE6R+31yo+HU2iT9fQiBs F4mZC6+wQtjCEq+Ob2GHsGUkTk/uATtUQmAbo8TV3z8ZIZz9jBLXe1dAVVlLHP73mw3iOE2J 9bv0IcKOEgtv3mEFCUsI8EnceCsIEmYGMidtm84MEeaV6GgTgqjWk3jaM5URZu2ftU+gYeUh 8XPxEmhYXWWUWLN3BcsERvlZCMsWMDKuYhRPLS3OTU8tNspLLdcrTswtLs1L10vOz93ECIz+ 0/+Of9nBuOtP0iFGAQ5GJR5ehae58UKsiWXFlbmHGCU4mJVEeJ3Ono4T4k1JrKxKLcqPLyrN SS0+xCjNwaIkzmu86GWskEB6YklqdmpqQWoRTJaJg1OqgbG6f6WksNDUfoNtfIoljh8PsM0/ NTHD/bRtxLd+F0Ufa9m3Bcw98t8qxSxeRvyQCTY8puCwKZVBW8u+UU6ujDs9O2TJAp3InyvL f5XYa/ovmnBFJsZA2z0+IeZ15c0mEfui+wr6Ce2zHCNWX31SzWR1UDvHxT6mPzGGQW/fgw+W VRyeu+qUWIozEg21mIuKEwGe/oy1+gIAAA== X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFjrBLMWRmVeSWpSXmKPExsVy+t/xe7p+RXnxBi1TGS1urLK36Jv0kcni 3aftTBbPetYxWvzr+MPuwOrxa8FSVo/Fe14yeRx8t4cpgDlKz6Yov7QkVSEjv7jEVina0MJI z9DSQs/IxFLP0Ng81srIVEnfziYlNSezLLVI3y5BL+Pisd+sBYelKt78Os/UwLhNtIuRk0NC wETiQctrli5GLg4hgaWMEq8+bWLuYuQASshIfLgkAFEjLPHnWhcbRM1HRokrDe/ZQRJsArYS R2Z+ZQWpFxEIkzix0h8kzCzgLrFl8VRmEFtYwE3i27sHjCA2i4CqxPKTr1hBbF4BV4kZG04y Q8yXl1i94QCYzQlSv28uM8SuRkaJnjd9rBMY+RYwMqxiFEktLc5Nzy021CtOzC0uzUvXS87P 3cQIDMVtx35u3sF4aWPwIUYBDkYlHt4Tj3LjhVgTy4orcw8xSnAwK4nwOp09HSfEm5JYWZVa lB9fVJqTWnyI0RToqonMUqLJ+cA4ySuJNzQ1NLewNDQ3Njc2s1AS5+0QOBgjJJCeWJKanZpa kFoE08fEwSnVwJh7bGfT5GbfTeYzHCT0uq59Plt21mvRzGUsNTftN+87LCHC01Re5l3iLL2u aDqf7CuF7LjUzXF8WquPJvlu4nkZ+euQ6ny+IkOD119TJkUFX4i4tzlKV2hWwMSO/RMtJ7jP n5B3Rbul1yzcUJv1l7x7rXmn2Wkmhy17Tmnlrt2685D6soeT9iixFGckGmoxFxUnAgBNcPRw WwIAAA== X-CMS-MailID: 20200925224222eucas1p1b10891c21bfef6784777526af4443dde X-Msg-Generator: CA Content-Type: text/plain; charset="utf-8" X-RootMTR: 20200925224222eucas1p1b10891c21bfef6784777526af4443dde X-EPHeader: CA CMS-TYPE: 201P X-CMS-RootMailID: 20200925224222eucas1p1b10891c21bfef6784777526af4443dde References: <20200923132541.21417-1-l.wojciechow@partner.samsung.com> <20200925224209.12173-1-l.wojciechow@partner.samsung.com> Subject: [dpdk-stable] [PATCH v4 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