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 A3B3CA04B1 for ; Sat, 10 Oct 2020 18:06:28 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E05EC1D94F; Sat, 10 Oct 2020 18:05:58 +0200 (CEST) Received: from mailout1.w1.samsung.com (mailout1.w1.samsung.com [210.118.77.11]) by dpdk.org (Postfix) with ESMTP id 51F071D953 for ; Sat, 10 Oct 2020 18:05:57 +0200 (CEST) Received: from eucas1p1.samsung.com (unknown [182.198.249.206]) by mailout1.w1.samsung.com (KnoxPortal) with ESMTP id 20201010160546euoutp01eab3371eb9f7665aa9a8f4b383a56856~8rSX8EkcU0381003810euoutp01f for ; Sat, 10 Oct 2020 16:05:46 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 mailout1.w1.samsung.com 20201010160546euoutp01eab3371eb9f7665aa9a8f4b383a56856~8rSX8EkcU0381003810euoutp01f DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com; s=mail20170921; t=1602345946; bh=fynvMAAU6OLk1/+zR+LOvZdNO64pUieNLjkvDKcsip8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=NMpkx5c/iK/ySVDAkEi5i5ciNyvO9UWFg3mUZpwe4C5hOTmon9MN5BhHRlwHsYfKY b4PGMHgfn6gbqyx7oTU8gf82MpHTm5uAE1YjcKXMprVk77t8OxgThIBPXQ6yueP6nw yGB5RZASET4VNlzLftbuzg9NFOKVnQ/rj8SKgtb8= Received: from eusmges3new.samsung.com (unknown [203.254.199.245]) by eucas1p2.samsung.com (KnoxPortal) with ESMTP id 20201010160540eucas1p2b31ea850d1def1a96a9f0ee8bcfdac07~8rSTBLQl70054800548eucas1p2_; Sat, 10 Oct 2020 16:05:40 +0000 (GMT) Received: from eucas1p1.samsung.com ( [182.198.249.206]) by eusmges3new.samsung.com (EUCPMTA) with SMTP id 5F.B2.06318.4DBD18F5; Sat, 10 Oct 2020 17:05:40 +0100 (BST) Received: from eusmtrp2.samsung.com (unknown [182.198.249.139]) by eucas1p2.samsung.com (KnoxPortal) with ESMTPA id 20201010160540eucas1p2d942834b4749672c433a37a8fe520bd1~8rSSZbPve0101201012eucas1p2r; Sat, 10 Oct 2020 16:05:40 +0000 (GMT) Received: from eusmgms1.samsung.com (unknown [182.198.249.179]) by eusmtrp2.samsung.com (KnoxPortal) with ESMTP id 20201010160540eusmtrp250d08ed983f789ee5f2920c3860bed02~8rSSY5-YO1692616926eusmtrp2I; Sat, 10 Oct 2020 16:05:40 +0000 (GMT) X-AuditID: cbfec7f5-38bff700000018ae-ce-5f81dbd45cdb Received: from eusmtip1.samsung.com ( [203.254.199.221]) by eusmgms1.samsung.com (EUCPMTA) with SMTP id B5.5A.06314.4DBD18F5; Sat, 10 Oct 2020 17:05:40 +0100 (BST) Received: from Padamandas.fritz.box (unknown [106.210.88.70]) by eusmtip1.samsung.com (KnoxPortal) with ESMTPA id 20201010160539eusmtip12c16ab15579d9afeaa4848e4d87e1705~8rSRneMrF2442224422eusmtip14; Sat, 10 Oct 2020 16:05:39 +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 18:05:01 +0200 Message-Id: <20201010160508.19709-11-l.wojciechow@partner.samsung.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20201010160508.19709-1-l.wojciechow@partner.samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFnrCIsWRmVeSWpSXmKPExsWy7djPc7pXbjfGG8z5qmVxY5W9Rd+kj0wW 7z5tZ7J41rOO0eJfxx92B1aPXwuWsnos3vOSyePguz1MAcxRXDYpqTmZZalF+nYJXBm3LpUU fJCquPisibmB8Z5oFyMHh4SAicSDruIuRi4OIYEVjBLLf19hhHC+MErs2T2BuYuRE8j5zCix 4IQiiA3ScPTuAjaI+HJGieP7ZCAaPjFKbDh4lwUkwSZgK3Fk5ldWEFtEIEyiuXkvC8g2ZgFn iSdfwXqFBTwknj59zQRiswioSty8c40RxOYVcJM4ueUiI8QueYnVGw6A3cAJFD/bdZANZJeE wGU2iRU3DrJBFLlIbJp9gAnCFpZ4dXwLO4QtI/F/53wmiIZtjBJXf/9khHD2M0pc710BVWUt cfjfbzaI6zQl1u/Shwg7Sty5/4YJEkR8EjfeCoKEmYHMSdumM0OEeSU62oQgqvUknvZMZYRZ +2ftExYI20Ni3snF7JDwucooMeFMA9MERvlZCMsWMDKuYhRPLS3OTU8tNs5LLdcrTswtLs1L 10vOz93ECIz70/+Of93BuO9P0iFGAQ5GJR7eA8cb44VYE8uKK3MPMUpwMCuJ8DqdPR0nxJuS WFmVWpQfX1Sak1p8iFGag0VJnNd40ctYIYH0xJLU7NTUgtQimCwTB6dUA6Nrh9q3rsfpKslz Uy//rgyUn3pt+cQdgpHHTu9tjoq6qZfsEFw7U/BfzPIroSocO59+iu3w8jzdxvu887jO3IID OjMv9m55VRcw65fMBi//L2XrhT0FlurlHEg22+zJ/8cyoWnOp8PnvFdlvn8VZPS/x/aGhrd2 25S76y/K2u73DowLVkuZ90+JpTgj0VCLuag4EQBRsCK49wIAAA== X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFjrOLMWRmVeSWpSXmKPExsVy+t/xu7pXbjfGG0xqY7e4screom/SRyaL d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoPZui/NKSVIWM/OISW6VoQwsj PUNLCz0jE0s9Q2PzWCsjUyV9O5uU1JzMstQifbsEvYxbl0oKPkhVXHzWxNzAeE+0i5GTQ0LA ROLo3QVsXYxcHEICSxklNmxdAuRwACVkJD5cEoCoEZb4c60LquYDo8TP+fvZQBJsArYSR2Z+ ZQWpFxEIkzix0h8kzCzgLrFl8VRmEFtYwEPi6dPXTCA2i4CqxM071xhBbF4BN4mTWy4yQsyX l1i94QBYPSdQ/GzXQahdjYwSJ27fZJvAyLeAkWEVo0hqaXFuem6xoV5xYm5xaV66XnJ+7iZG YCBuO/Zz8w7GSxuDDzEKcDAq8fBKnGqMF2JNLCuuzD3EKMHBrCTC63T2dJwQb0piZVVqUX58 UWlOavEhRlOgqyYyS4km5wOjJK8k3tDU0NzC0tDc2NzYzEJJnLdD4GCMkEB6YklqdmpqQWoR TB8TB6dUA2O97BueJaJZvJyu6iuTK6t2yOeJvgrP3L751RFBobPnH81u9emdn3ihrizvEees o6V3nplxTn77wvrv7rPPFvHqcpnXbRT3Ncmz+vzx7YHIr69ufE7YJLwpNVFoaljyIoPtTRuW Sa5zc+40SFj7rDlE48DlZE+7n3dOGpZ82qp+rTYna7Hp+nglluKMREMt5qLiRAAF/HbRWgIA AA== X-CMS-MailID: 20201010160540eucas1p2d942834b4749672c433a37a8fe520bd1 X-Msg-Generator: CA Content-Type: text/plain; charset="utf-8" X-RootMTR: 20201010160540eucas1p2d942834b4749672c433a37a8fe520bd1 X-EPHeader: CA CMS-TYPE: 201P X-CMS-RootMailID: 20201010160540eucas1p2d942834b4749672c433a37a8fe520bd1 References: <20201009220202.20834-1-l.wojciechow@partner.samsung.com> <20201010160508.19709-1-l.wojciechow@partner.samsung.com> Subject: [dpdk-stable] [PATCH v7 10/16] 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