Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/80240/?format=api
{ "id": 80240, "url": "https://patches.dpdk.org/api/patches/80240/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20201009220202.20834-11-l.wojciechow@partner.samsung.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20201009220202.20834-11-l.wojciechow@partner.samsung.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20201009220202.20834-11-l.wojciechow@partner.samsung.com", "date": "2020-10-09T22:01:57", "name": "[v6,10/15] distributor: align API documentation with code", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "a889bf8bbf3c25dd9054fb604a8b1ba3d6cd04fc", "submitter": { "id": 1628, "url": "https://patches.dpdk.org/api/people/1628/?format=api", "name": "Lukasz Wojciechowski", "email": "l.wojciechow@partner.samsung.com" }, "delegate": { "id": 24651, "url": "https://patches.dpdk.org/api/users/24651/?format=api", "username": "dmarchand", "first_name": "David", "last_name": "Marchand", "email": "david.marchand@redhat.com" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20201009220202.20834-11-l.wojciechow@partner.samsung.com/mbox/", "series": [ { "id": 12840, "url": "https://patches.dpdk.org/api/series/12840/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=12840", "date": "2020-10-09T22:01:47", "name": "fix distributor synchronization issues", "version": 6, "mbox": "https://patches.dpdk.org/series/12840/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/80240/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/80240/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from dpdk.org (dpdk.org [92.243.14.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id A0BEDA04BC;\n\tSat, 10 Oct 2020 00:06:31 +0200 (CEST)", "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 32F531D694;\n\tSat, 10 Oct 2020 00:03:17 +0200 (CEST)", "from mailout2.w1.samsung.com (mailout2.w1.samsung.com\n [210.118.77.12]) by dpdk.org (Postfix) with ESMTP id 09A9A1D666\n for <dev@dpdk.org>; Sat, 10 Oct 2020 00:03:09 +0200 (CEST)", "from eucas1p1.samsung.com (unknown [182.198.249.206])\n by mailout2.w1.samsung.com (KnoxPortal) with ESMTP id\n 20201009220254euoutp0291bfdd748baaf3d18cadc1e34e2efd07~8cg6mz5FV2454124541euoutp02J\n for <dev@dpdk.org>; Fri, 9 Oct 2020 22:02:54 +0000 (GMT)", "from eusmges1new.samsung.com (unknown [203.254.199.242]) by\n eucas1p1.samsung.com (KnoxPortal) with ESMTP id\n 20201009220248eucas1p136ad470b30de992daf84753fe3e59b8f~8cg08lYR01072710727eucas1p1m;\n Fri, 9 Oct 2020 22:02:48 +0000 (GMT)", "from eucas1p2.samsung.com ( [182.198.249.207]) by\n eusmges1new.samsung.com (EUCPMTA) with SMTP id AF.77.06456.80ED08F5; Fri, 9\n Oct 2020 23:02:48 +0100 (BST)", "from eusmtrp2.samsung.com (unknown [182.198.249.139]) by\n eucas1p1.samsung.com (KnoxPortal) with ESMTPA id\n 20201009220248eucas1p156346857c1aab2340ccd7549abdce966~8cg0mrw5A1023910239eucas1p1e;\n Fri, 9 Oct 2020 22:02:48 +0000 (GMT)", "from eusmgms1.samsung.com (unknown [182.198.249.179]) by\n eusmtrp2.samsung.com (KnoxPortal) with ESMTP id\n 20201009220248eusmtrp270636e8194bb792b3f9371403779a750~8cg0mNXMl1642116421eusmtrp2i;\n Fri, 9 Oct 2020 22:02:48 +0000 (GMT)", "from eusmtip1.samsung.com ( [203.254.199.221]) by\n eusmgms1.samsung.com (EUCPMTA) with SMTP id 44.E2.06314.80ED08F5; Fri, 9\n Oct 2020 23:02:48 +0100 (BST)", "from Padamandas.fritz.box (unknown [106.210.88.70]) by\n eusmtip1.samsung.com (KnoxPortal) with ESMTPA id\n 20201009220247eusmtip14dfa75672817af520c9810563a17ccb0~8cg0BZEq51990219902eusmtip1J;\n Fri, 9 Oct 2020 22:02:47 +0000 (GMT)" ], "DKIM-Filter": "OpenDKIM Filter v2.11.0 mailout2.w1.samsung.com\n 20201009220254euoutp0291bfdd748baaf3d18cadc1e34e2efd07~8cg6mz5FV2454124541euoutp02J", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com;\n s=mail20170921; t=1602280974;\n bh=fynvMAAU6OLk1/+zR+LOvZdNO64pUieNLjkvDKcsip8=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=JHg0PxhVtdVH6OYQg5ixu/BGxgJSxtiCsZBK2tm3P3OkCgNN1fb/dC27l+bsN8c6J\n 5wM+l8QGFFFPx+PEwLfSQJVifVOoCPESC1uzfzJ3fGosNlaOvjjlDDVogDGwnHZtEx\n WDg7gv/q7r9WP9U+tlTg26Uf4yyTwffI6s69jcls=", "X-AuditID": "cbfec7f2-809ff70000001938-14-5f80de08d91e", "From": "Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>", "To": "David Hunt <david.hunt@intel.com>, Bruce Richardson\n <bruce.richardson@intel.com>", "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": [ "\n H4sIAAAAAAAAA+NgFnrKIsWRmVeSWpSXmKPExsWy7djP87oc9xriDf4+lbO4screom/SRyaL\n d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoLpuU1JzMstQifbsEroxbl0oK\n PkhVXHzWxNzAeE+0i5GTQ0LARKJv2SW2LkYuDiGBFYwSG17MYIdwvjBK9E05zArhfGaU6O/e\n wArTsmhyPxNEYjmjxNOmE1AtnxgldnafZgSpYhOwlTgy8ytYh4hAmERz816WLkYODmYBZ4kn\n X9lAwsICHhJrOxezgYRZBFQlJv6oBQnzCrhJXDoLcgXILnmJ1RsOMIPYnEDx1l3LWCDi19kk\n ervyIGwXic1PTrBB2MISr45vgeqVkfi/cz7YnRIC2xglrv7+yQjh7GeUuN67AqrKWuLwv99s\n ELdpSqzfpQ8RdpRYsWkDI0hYQoBP4sZbQZAwM5A5adt0Zogwr0RHmxBEtZ7E056pjDBr/6x9\n AnWmh8Saf7egoXuVUeLAwSbmCYzysxCWLWBkXMUonlpanJueWmyYl1quV5yYW1yal66XnJ+7\n iREY+af/Hf+0g/HrpaRDjAIcjEo8vA3JDfFCrIllxZW5hxglOJiVRHidzp6OE+JNSaysSi3K\n jy8qzUktPsQozcGiJM5rvOhlrJBAemJJanZqakFqEUyWiYNTqoFxpvzrjCzV4IjV3tNVt89l\n /5sbovtto2zJ06uWDIfkNpyfuEOFa64Dx6u3Zmk1POc6+Oojf3XJm53T/rttbSDzRrZ7kZmF\n Wl0ZU6+bXs9SsDmvUMe/tm3hzfXPPTMjgt79P3Ms02H5tTSHzVFhkfwWXsalf7vPuvQ+entt\n /tMu5VSJu1zH71xXYinOSDTUYi4qTgQA/i3XkfgCAAA=", "\n H4sIAAAAAAAAA+NgFjrGLMWRmVeSWpSXmKPExsVy+t/xu7oc9xriDZYs4bK4screom/SRyaL\n d5+2M1k861nHaPGv4w+7A6vHrwVLWT0W73nJ5HHw3R6mAOYoPZui/NKSVIWM/OISW6VoQwsj\n PUNLCz0jE0s9Q2PzWCsjUyV9O5uU1JzMstQifbsEvYxbl0oKPkhVXHzWxNzAeE+0i5GTQ0LA\n RGLR5H6mLkYuDiGBpYwSFxf2MXYxcgAlZCQ+XBKAqBGW+HOtiw2i5gOjxLHvWxlBEmwCthJH\n Zn5lBakXEQiTOLHSHyTMLOAusWXxVGYQW1jAQ2Jt52I2kBIWAVWJiT9qQcK8Am4Sl87OYIcY\n Ly+xesMBsHJOoHjrrmUsEKsaGSW2HHjJPIGRbwEjwypGkdTS4tz03GJDveLE3OLSvHS95Pzc\n TYzAMNx27OfmHYyXNgYfYhTgYFTi4dVIbIgXYk0sK67MPcQowcGsJMLrdPZ0nBBvSmJlVWpR\n fnxRaU5q8SFGU6CjJjJLiSbnA2MkryTe0NTQ3MLS0NzY3NjMQkmct0PgYIyQQHpiSWp2ampB\n ahFMHxMHp1QDo8Jr1SP2875KXpJ6KHXK6n7i7xe83/NyVv1PeKjgKmt2dtes6Tt5Ys4fOlUz\n YWue9Z+9mTcfT+I+HbBYrnzBpl83E2W9I3vkq6T/Hrp9UFljl8Ld7CuXwqsK5n1ZolgXJZO6\n 3/D//uj4o0f27azZEiAh77ipQeaV+oSD2dxs/W5fTQ5kbq+3FVZiKc5INNRiLipOBADLVWIK\n 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>\n <20201009220202.20834-1-l.wojciechow@partner.samsung.com>\n <CGME20201009220248eucas1p156346857c1aab2340ccd7549abdce966@eucas1p1.samsung.com>", "Subject": "[dpdk-dev] [PATCH v6 10/15] distributor: align API documentation\n\twith code", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "After introducing burst API there were some artefacts in the\nAPI documentation from legacy single API.\nAlso the rte_distributor_poll_pkt() function return values\nmismatched the implementation.\n\nFixes: c0de0eb82e40 (\"distributor: switch over to new API\")\nCc: david.hunt@intel.com\nCc: stable@dpdk.org\n\nSigned-off-by: Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>\nAcked-by: David Hunt <david.hunt@intel.com>\n---\n lib/librte_distributor/rte_distributor.h | 23 ++++++++++++-----------\n 1 file changed, 12 insertions(+), 11 deletions(-)", "diff": "diff --git a/lib/librte_distributor/rte_distributor.h b/lib/librte_distributor/rte_distributor.h\nindex 327c0c4ab..a073e6461 100644\n--- a/lib/librte_distributor/rte_distributor.h\n+++ b/lib/librte_distributor/rte_distributor.h\n@@ -155,7 +155,7 @@ rte_distributor_clear_returns(struct rte_distributor *d);\n * @param pkts\n * The mbufs pointer array to be filled in (up to 8 packets)\n * @param oldpkt\n- * The previous packet, if any, being processed by the worker\n+ * The previous packets, if any, being processed by the worker\n * @param retcount\n * The number of packets being returned\n *\n@@ -187,15 +187,15 @@ rte_distributor_return_pkt(struct rte_distributor *d,\n \n /**\n * API called by a worker to request a new packet to process.\n- * Any previous packet given to the worker is assumed to have completed\n+ * Any previous packets given to the worker are assumed to have completed\n * processing, and may be optionally returned to the distributor via\n * the oldpkt parameter.\n- * Unlike rte_distributor_get_pkt_burst(), this function does not wait for a\n- * new packet to be provided by the distributor.\n+ * Unlike rte_distributor_get_pkt(), this function does not wait for\n+ * new packets to be provided by the distributor.\n *\n- * NOTE: after calling this function, rte_distributor_poll_pkt_burst() should\n- * be used to poll for the packet requested. The rte_distributor_get_pkt_burst()\n- * API should *not* be used to try and retrieve the new packet.\n+ * NOTE: after calling this function, rte_distributor_poll_pkt() should\n+ * be used to poll for the packets requested. The rte_distributor_get_pkt()\n+ * API should *not* be used to try and retrieve the new packets.\n *\n * @param d\n * The distributor instance to be used\n@@ -213,9 +213,9 @@ rte_distributor_request_pkt(struct rte_distributor *d,\n \t\tunsigned int count);\n \n /**\n- * API called by a worker to check for a new packet that was previously\n+ * API called by a worker to check for new packets that were previously\n * requested by a call to rte_distributor_request_pkt(). It does not wait\n- * for the new packet to be available, but returns NULL if the request has\n+ * for the new packets to be available, but returns if the request has\n * not yet been fulfilled by the distributor.\n *\n * @param d\n@@ -227,8 +227,9 @@ rte_distributor_request_pkt(struct rte_distributor *d,\n * The array of mbufs being given to the worker\n *\n * @return\n- * The number of packets being given to the worker thread, zero if no\n- * packet is yet available.\n+ * The number of packets being given to the worker thread,\n+ * -1 if no packets are yet available (burst API - RTE_DIST_ALG_BURST)\n+ * 0 if no packets are yet available (legacy single API - RTE_DIST_ALG_SINGLE)\n */\n int\n rte_distributor_poll_pkt(struct rte_distributor *d,\n", "prefixes": [ "v6", "10/15" ] }