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 92615A04BC for ; Sat, 10 Oct 2020 00:03:45 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id BFF8C1D69D; Sat, 10 Oct 2020 00:03:18 +0200 (CEST) Received: from mailout2.w1.samsung.com (mailout2.w1.samsung.com [210.118.77.12]) by dpdk.org (Postfix) with ESMTP id 083F41D664 for ; Sat, 10 Oct 2020 00:03:10 +0200 (CEST) Received: from eucas1p1.samsung.com (unknown [182.198.249.206]) by mailout2.w1.samsung.com (KnoxPortal) with ESMTP id 20201009220258euoutp02247fa885823b3b53cb07df4f07e4bdcd~8cg_DYuzk1685816858euoutp02s for ; Fri, 9 Oct 2020 22:02:58 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 mailout2.w1.samsung.com 20201009220258euoutp02247fa885823b3b53cb07df4f07e4bdcd~8cg_DYuzk1685816858euoutp02s DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com; s=mail20170921; t=1602280978; bh=fynvMAAU6OLk1/+zR+LOvZdNO64pUieNLjkvDKcsip8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=PEDbaO2Vufc7gJGVfpTaUnykfeE8HWhRF8VvSFZC9QjDg0jczjV/UuOU/D8V3uQ68 SKnlXLGO0dX9cC84SWi3EZKmodPYgbiGvi0oGar2i7Ke8qHu2Wp8vicjD04s479G+w 8Sq0LIyYbrEW9s1XQt37N9OFWbpHq/I/fENTRnNM= Received: from eusmges1new.samsung.com (unknown [203.254.199.242]) by eucas1p1.samsung.com (KnoxPortal) with ESMTP id 20201009220248eucas1p136ad470b30de992daf84753fe3e59b8f~8cg08lYR01072710727eucas1p1m; Fri, 9 Oct 2020 22:02:48 +0000 (GMT) Received: from eucas1p2.samsung.com ( [182.198.249.207]) by eusmges1new.samsung.com (EUCPMTA) with SMTP id AF.77.06456.80ED08F5; Fri, 9 Oct 2020 23:02:48 +0100 (BST) Received: from eusmtrp2.samsung.com (unknown [182.198.249.139]) by eucas1p1.samsung.com (KnoxPortal) with ESMTPA id 20201009220248eucas1p156346857c1aab2340ccd7549abdce966~8cg0mrw5A1023910239eucas1p1e; Fri, 9 Oct 2020 22:02:48 +0000 (GMT) Received: from eusmgms1.samsung.com (unknown [182.198.249.179]) by eusmtrp2.samsung.com (KnoxPortal) with ESMTP id 20201009220248eusmtrp270636e8194bb792b3f9371403779a750~8cg0mNXMl1642116421eusmtrp2i; Fri, 9 Oct 2020 22:02:48 +0000 (GMT) X-AuditID: cbfec7f2-809ff70000001938-14-5f80de08d91e Received: from eusmtip1.samsung.com ( [203.254.199.221]) by eusmgms1.samsung.com (EUCPMTA) with SMTP id 44.E2.06314.80ED08F5; Fri, 9 Oct 2020 23:02:48 +0100 (BST) Received: from Padamandas.fritz.box (unknown [106.210.88.70]) by eusmtip1.samsung.com (KnoxPortal) with ESMTPA id 20201009220247eusmtip14dfa75672817af520c9810563a17ccb0~8cg0BZEq51990219902eusmtip1J; Fri, 9 Oct 2020 22:02:47 +0000 (GMT) From: Lukasz Wojciechowski To: David Hunt , Bruce Richardson Cc: dev@dpdk.org, l.wojciechow@partner.samsung.com, stable@dpdk.org Date: Sat, 10 Oct 2020 00:01:57 +0200 Message-Id: <20201009220202.20834-11-l.wojciechow@partner.samsung.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20201009220202.20834-1-l.wojciechow@partner.samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFnrKIsWRmVeSWpSXmKPExsWy7djP87oc9xriDf4+lbO4screom/SRyaL d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoLpuU1JzMstQifbsEroxbl0oK PkhVXHzWxNzAeE+0i5GTQ0LARKJv2SW2LkYuDiGBFYwSG17MYIdwvjBK9E05zArhfGaU6O/e wArTsmhyPxNEYjmjxNOmE1AtnxgldnafZgSpYhOwlTgy8ytYh4hAmERz816WLkYODmYBZ4kn X9lAwsICHhJrOxezgYRZBFQlJv6oBQnzCrhJXDoLcgXILnmJ1RsOMIPYnEDx1l3LWCDi19kk ervyIGwXic1PTrBB2MISr45vgeqVkfi/cz7YnRIC2xglrv7+yQjh7GeUuN67AqrKWuLwv99s ELdpSqzfpQ8RdpRYsWkDI0hYQoBP4sZbQZAwM5A5adt0Zogwr0RHmxBEtZ7E056pjDBr/6x9 AnWmh8Saf7egoXuVUeLAwSbmCYzysxCWLWBkXMUonlpanJueWmyYl1quV5yYW1yal66XnJ+7 iREY+af/Hf+0g/HrpaRDjAIcjEo8vA3JDfFCrIllxZW5hxglOJiVRHidzp6OE+JNSaysSi3K jy8qzUktPsQozcGiJM5rvOhlrJBAemJJanZqakFqEUyWiYNTqoFxpvzrjCzV4IjV3tNVt89l /5sbovtto2zJ06uWDIfkNpyfuEOFa64Dx6u3Zmk1POc6+Oojf3XJm53T/rttbSDzRrZ7kZmF Wl0ZU6+bXs9SsDmvUMe/tm3hzfXPPTMjgt79P3Ms02H5tTSHzVFhkfwWXsalf7vPuvQ+entt /tMu5VSJu1zH71xXYinOSDTUYi4qTgQA/i3XkfgCAAA= X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFjrGLMWRmVeSWpSXmKPExsVy+t/xu7oc9xriDZYs4bK4screom/SRyaL d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoPZui/NKSVIWM/OISW6VoQwsj PUNLCz0jE0s9Q2PzWCsjUyV9O5uU1JzMstQifbsEvYxbl0oKPkhVXHzWxNzAeE+0i5GTQ0LA RGLR5H6mLkYuDiGBpYwSFxf2MXYxcgAlZCQ+XBKAqBGW+HOtiw2i5gOjxLHvWxlBEmwCthJH Zn5lBakXEQiTOLHSHyTMLOAusWXxVGYQW1jAQ2Jt52I2kBIWAVWJiT9qQcK8Am4Sl87OYIcY Ly+xesMBsHJOoHjrrmUsEKsaGSW2HHjJPIGRbwEjwypGkdTS4tz03GJDveLE3OLSvHS95Pzc TYzAMNx27OfmHYyXNgYfYhTgYFTi4dVIbIgXYk0sK67MPcQowcGsJMLrdPZ0nBBvSmJlVWpR fnxRaU5q8SFGU6CjJjJLiSbnA2MkryTe0NTQ3MLS0NzY3NjMQkmct0PgYIyQQHpiSWp2ampB ahFMHxMHp1QDo8Jr1SP2875KXpJ6KHXK6n7i7xe83/NyVv1PeKjgKmt2dtes6Tt5Ys4fOlUz YWue9Z+9mTcfT+I+HbBYrnzBpl83E2W9I3vkq6T/Hrp9UFljl8Ld7CuXwqsK5n1ZolgXJZO6 3/D//uj4o0f27azZEiAh77ipQeaV+oSD2dxs/W5fTQ5kbq+3FVZiKc5INNRiLipOBADLVWIK WQIAAA== X-CMS-MailID: 20201009220248eucas1p156346857c1aab2340ccd7549abdce966 X-Msg-Generator: CA Content-Type: text/plain; charset="utf-8" X-RootMTR: 20201009220248eucas1p156346857c1aab2340ccd7549abdce966 X-EPHeader: CA CMS-TYPE: 201P X-CMS-RootMailID: 20201009220248eucas1p156346857c1aab2340ccd7549abdce966 References: <20201008052323.11547-1-l.wojciechow@partner.samsung.com> <20201009220202.20834-1-l.wojciechow@partner.samsung.com> Subject: [dpdk-stable] [PATCH v6 10/15] 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 Acked-by: David Hunt --- 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