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 D38AEA04DB for ; Sat, 17 Oct 2020 05:08:32 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E8A3FE2EF; Sat, 17 Oct 2020 05:08:10 +0200 (CEST) Received: from mailout2.w1.samsung.com (mailout2.w1.samsung.com [210.118.77.12]) by dpdk.org (Postfix) with ESMTP id A46BAE2AB for ; Sat, 17 Oct 2020 05:07:39 +0200 (CEST) Received: from eucas1p2.samsung.com (unknown [182.198.249.207]) by mailout2.w1.samsung.com (KnoxPortal) with ESMTP id 20201017030722euoutp026e9cd208c95bd2aeff3b2c6cbfe96d6c~_qLvhRPgd2305923059euoutp02U for ; Sat, 17 Oct 2020 03:07:22 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 mailout2.w1.samsung.com 20201017030722euoutp026e9cd208c95bd2aeff3b2c6cbfe96d6c~_qLvhRPgd2305923059euoutp02U DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com; s=mail20170921; t=1602904042; bh=fynvMAAU6OLk1/+zR+LOvZdNO64pUieNLjkvDKcsip8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=nPhfBget/MI+k+k7sSQvtPyxcGo2txQiYjG2Saoirht+0UHXZUbdB9DixHiTXgl4J sPiPZ4TOdRsgmUsRnIk3Mq/iYbT1lXOD9+/pTXaK5aGPwjjPh1XqHfNfxx5oEyXaJG zDjPzq1Q2q18pZeIWEX7JcyZapWCwglWkbGV9odQ= Received: from eusmges2new.samsung.com (unknown [203.254.199.244]) by eucas1p2.samsung.com (KnoxPortal) with ESMTP id 20201017030719eucas1p2bab72f14313b7dcd3f72c5ed93981a21~_qLtP0J2V2441224412eucas1p2-; Sat, 17 Oct 2020 03:07:19 +0000 (GMT) Received: from eucas1p2.samsung.com ( [182.198.249.207]) by eusmges2new.samsung.com (EUCPMTA) with SMTP id 93.42.05997.7EF5A8F5; Sat, 17 Oct 2020 04:07:19 +0100 (BST) Received: from eusmtrp2.samsung.com (unknown [182.198.249.139]) by eucas1p2.samsung.com (KnoxPortal) with ESMTPA id 20201017030718eucas1p256e1f934af12af2a6b07640c9de7a766~_qLsHGb361942819428eucas1p2x; Sat, 17 Oct 2020 03:07:18 +0000 (GMT) Received: from eusmgms1.samsung.com (unknown [182.198.249.179]) by eusmtrp2.samsung.com (KnoxPortal) with ESMTP id 20201017030718eusmtrp24668aa7eeb9aa84b6ee2e43bc351f107~_qLsGl_rK2572125721eusmtrp2j; Sat, 17 Oct 2020 03:07:18 +0000 (GMT) X-AuditID: cbfec7f4-677ff7000000176d-c3-5f8a5fe78366 Received: from eusmtip1.samsung.com ( [203.254.199.221]) by eusmgms1.samsung.com (EUCPMTA) with SMTP id 8B.99.06314.6EF5A8F5; Sat, 17 Oct 2020 04:07:18 +0100 (BST) Received: from localhost.localdomain (unknown [106.210.88.70]) by eusmtip1.samsung.com (KnoxPortal) with ESMTPA id 20201017030717eusmtip122abc76b9830dfab5f100f4375c7bf66~_qLrOMbnC0424404244eusmtip1P; Sat, 17 Oct 2020 03:07:17 +0000 (GMT) From: Lukasz Wojciechowski To: David Hunt , Bruce Richardson Cc: dev@dpdk.org, l.wojciechow@partner.samsung.com, stable@dpdk.org Date: Sat, 17 Oct 2020 05:06:54 +0200 Message-Id: <20201017030701.16134-11-l.wojciechow@partner.samsung.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20201017030701.16134-1-l.wojciechow@partner.samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFnrMIsWRmVeSWpSXmKPExsWy7djP87rP47viDa4807W4screom/SRyaL d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoLpuU1JzMstQifbsEroxbl0oK PkhVXHzWxNzAeE+0i5GTQ0LARGLBvolMXYxcHEICKxglHr87zAiSEBL4wijRuIERIvGZUeLt nrPsMB03tl9lhihazijRPE8BwgYq+tErB2KzCdhKHJn5lRXEFhEIk2hu3svSxcjBwSzgLPHk KxtIWFjAQ6J3SxdYCYuAqsS1Q7fBxvMKuEkcXb2aBWKVvMTqDQeYQVo5geKNx11BzpEQuMwm cebkNSaIGheJaf8fQp0mLPHq+BYoW0bi/875TBAN2xglrv7+yQjh7GeUuN67AqrKWuLwv99s EMdpSqzfpQ8RdpR4ML+JESQsIcAnceOtIEiYGcictG06M0SYV6KjTQiiWk/iac9URpi1f9Y+ gTrfQ+LK/rdskCC8yiixfutJtgmM8rMQli1gZFzFKJ5aWpybnlpslJdarlecmFtcmpeul5yf u4kRGPWn/x3/soNx15+kQ4wCHIxKPLwcSzvjhVgTy4orcw8xSnAwK4nwOp09HSfEm5JYWZVa lB9fVJqTWnyIUZqDRUmc13jRy1ghgfTEktTs1NSC1CKYLBMHp1QD49YKCbGGDRw33r94VHI4 Nnr97tTFVvtKnKwYJix9bLbQLU5ky0M/w4RJm8snSbBoT/imJnXJWWXht/eHrxTm+vLHPNwQ uuD9m1fT1ZWbvD+cXurXKfr+ZxnzvioFqeoL6lfenWSOl2RlPLwqe/nLzof76peev7UkYaHf K0+tOutjZ2M2m/7cVafEUpyRaKjFXFScCACVcYaH9gIAAA== X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFjrGLMWRmVeSWpSXmKPExsVy+t/xu7rP4rviDT4elre4screom/SRyaL d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoPZui/NKSVIWM/OISW6VoQwsj PUNLCz0jE0s9Q2PzWCsjUyV9O5uU1JzMstQifbsEvYxbl0oKPkhVXHzWxNzAeE+0i5GTQ0LA ROLG9qvMXYxcHEICSxklLnztBXI4gBIyEh8uCUDUCEv8udbFBlHzkVFiass6JpAEm4CtxJGZ X1lB6kUEwiROrPQHCTMLuEtsWTyVGcQWFvCQ6N3SxQpiswioSlw7dJsdxOYVcJM4uno1C8R8 eYnVGw6AreUEijced4VY1cgocXbWOpYJjHwLGBlWMYqklhbnpucWG+oVJ+YWl+al6yXn525i BIbhtmM/N+9gvLQx+BCjAAejEg/vhkWd8UKsiWXFlbmHGCU4mJVEeJ3Ono4T4k1JrKxKLcqP LyrNSS0+xGgKdNREZinR5HxgjOSVxBuaGppbWBqaG5sbm1koifN2CByMERJITyxJzU5NLUgt gulj4uCUamCcWh99ZsmtOr9+lWWspTpN7K+CtJ+Url3KkLWOYfW9aWv+RJrH7tspGLRmuweL f9kVH9u8v0VHlu9cnKV3RCtKe1PAFIG129l8XTO+5c5l/jcj+dmmditmqWsh0hKNFj43LRw1 YxmW3u2IfP39y06DkpM75wgLlpTqqPSc/Kgtx7xJUWLhumlKLMUZiYZazEXFiQAtfrCgWQIA AA== X-CMS-MailID: 20201017030718eucas1p256e1f934af12af2a6b07640c9de7a766 X-Msg-Generator: CA Content-Type: text/plain; charset="utf-8" X-RootMTR: 20201017030718eucas1p256e1f934af12af2a6b07640c9de7a766 X-EPHeader: CA CMS-TYPE: 201P X-CMS-RootMailID: 20201017030718eucas1p256e1f934af12af2a6b07640c9de7a766 References: <20201010160508.19709-1-l.wojciechow@partner.samsung.com> <20201017030701.16134-1-l.wojciechow@partner.samsung.com> Subject: [dpdk-stable] [PATCH v8 10/17] 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