Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/100121/?format=api
{ "id": 100121, "url": "https://patches.dpdk.org/api/patches/100121/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20210930160156.961041-2-andrew.rybchenko@oktetlabs.ru/", "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": "<20210930160156.961041-2-andrew.rybchenko@oktetlabs.ru>", "list_archive_url": "https://inbox.dpdk.org/dev/20210930160156.961041-2-andrew.rybchenko@oktetlabs.ru", "date": "2021-09-30T16:01:49", "name": "[v7,1/5] ethdev: fix docs of functions getting xstats by IDs", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "f59754ff0251d5c45920cd4574cebff8a6b8f53f", "submitter": { "id": 2013, "url": "https://patches.dpdk.org/api/people/2013/?format=api", "name": "Andrew Rybchenko", "email": "Andrew.Rybchenko@oktetlabs.ru" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20210930160156.961041-2-andrew.rybchenko@oktetlabs.ru/mbox/", "series": [ { "id": 19301, "url": "https://patches.dpdk.org/api/series/19301/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=19301", "date": "2021-09-30T16:01:49", "name": "[v7,1/5] ethdev: fix docs of functions getting xstats by IDs", "version": 7, "mbox": "https://patches.dpdk.org/series/19301/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/100121/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/100121/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 mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 2988FA0C43;\n\tThu, 30 Sep 2021 18:02:12 +0200 (CEST)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 59AD1410EB;\n\tThu, 30 Sep 2021 18:02:09 +0200 (CEST)", "from shelob.oktetlabs.ru (shelob.oktetlabs.ru [91.220.146.113])\n by mails.dpdk.org (Postfix) with ESMTP id C12B140DDA;\n Thu, 30 Sep 2021 18:02:07 +0200 (CEST)", "by shelob.oktetlabs.ru (Postfix, from userid 122)\n id 9237D7F6DE; Thu, 30 Sep 2021 19:02:07 +0300 (MSK)", "from aros.oktetlabs.ru (aros.oktetlabs.ru [192.168.38.17])\n by shelob.oktetlabs.ru (Postfix) with ESMTP id 21A7E7F6C1;\n Thu, 30 Sep 2021 19:02:00 +0300 (MSK)" ], "X-Spam-Checker-Version": "SpamAssassin 3.4.2 (2018-09-13) on shelob.oktetlabs.ru", "X-Spam-Level": "", "X-Spam-Status": "No, score=0.8 required=5.0 tests=ALL_TRUSTED,\n DKIM_ADSP_DISCARD,\n URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.2", "DKIM-Filter": "OpenDKIM Filter v2.11.0 shelob.oktetlabs.ru 21A7E7F6C1", "Authentication-Results": "shelob.oktetlabs.ru/21A7E7F6C1; dkim=none;\n dkim-atps=neutral", "From": "Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>", "To": "Thomas Monjalon <thomas@monjalon.net>,\n Ferruh Yigit <ferruh.yigit@intel.com>, Kuba Kozak <kubax.kozak@intel.com>", "Cc": "dev@dpdk.org, Ivan Ilchenko <ivan.ilchenko@oktetlabs.ru>, stable@dpdk.org,\n Andy Moreton <amoreton@xilinx.com>", "Date": "Thu, 30 Sep 2021 19:01:49 +0300", "Message-Id": "<20210930160156.961041-2-andrew.rybchenko@oktetlabs.ru>", "X-Mailer": "git-send-email 2.30.2", "In-Reply-To": "<20210930160156.961041-1-andrew.rybchenko@oktetlabs.ru>", "References": "<20210604144225.287678-1-andrew.rybchenko@oktetlabs.ru>\n <20210930160156.961041-1-andrew.rybchenko@oktetlabs.ru>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[dpdk-dev] [PATCH v7 1/5] ethdev: fix docs of functions getting\n xstats by IDs", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "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": "From: Ivan Ilchenko <ivan.ilchenko@oktetlabs.ru>\n\nDocument valid combinations of input arguments in accordance with\ncurrent implementation in ethdev.\n\nFixes: 79c913a42f0 (\"ethdev: retrieve xstats by ID\")\nCc: stable@dpdk.org\n\nSigned-off-by: Ivan Ilchenko <ivan.ilchenko@oktetlabs.ru>\nSigned-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>\nReviewed-by: Andy Moreton <amoreton@xilinx.com>\nReviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>\n---\n lib/ethdev/rte_ethdev.h | 35 +++++++++++++++++++----------------\n 1 file changed, 19 insertions(+), 16 deletions(-)", "diff": "diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h\nindex afdc53b674..2ad2bf2019 100644\n--- a/lib/ethdev/rte_ethdev.h\n+++ b/lib/ethdev/rte_ethdev.h\n@@ -2896,21 +2896,23 @@ int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param xstats_names\n- * An rte_eth_xstat_name array of at least *size* elements to\n- * be filled. If set to NULL, the function returns the required number\n- * of elements.\n- * @param ids\n- * IDs array given by app to retrieve specific statistics\n+ * Array to be filled in with names of requested device statistics.\n+ * Must not be NULL if @p ids are specified (not NULL).\n * @param size\n- * The size of the xstats_names array (number of elements).\n+ * Number of elements in @p xstats_names array (if not NULL) and in\n+ * @p ids array (if not NULL). Must be 0 if both array pointers are NULL.\n+ * @param ids\n+ * IDs array given by app to retrieve specific statistics. May be NULL to\n+ * retrieve names of all available statistics or, if @p xstats_names is\n+ * NULL as well, just the number of available statistics.\n * @return\n * - A positive value lower or equal to size: success. The return value\n * is the number of entries filled in the stats table.\n- * - A positive value higher than size: error, the given statistics table\n+ * - A positive value higher than size: success. The given statistics table\n * is too small. The return value corresponds to the size that should\n * be given to succeed. The entries in the table are not valid and\n * shall not be used by the caller.\n- * - A negative value on error (invalid port id).\n+ * - A negative value on error.\n */\n int\n rte_eth_xstats_get_names_by_id(uint16_t port_id,\n@@ -2923,22 +2925,23 @@ rte_eth_xstats_get_names_by_id(uint16_t port_id,\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param ids\n- * A pointer to an ids array passed by application. This tells which\n- * statistics values function should retrieve. This parameter\n- * can be set to NULL if size is 0. In this case function will retrieve\n- * all available statistics.\n+ * IDs array given by app to retrieve specific statistics. May be NULL to\n+ * retrieve all available statistics or, if @p values is NULL as well,\n+ * just the number of available statistics.\n * @param values\n- * A pointer to a table to be filled with device statistics values.\n+ * Array to be filled in with requested device statistics.\n+ * Must not be NULL if ids are specified (not NULL).\n * @param size\n- * The size of the ids array (number of elements).\n+ * Number of elements in @p values array (if not NULL) and in @p ids\n+ * array (if not NULL). Must be 0 if both array pointers are NULL.\n * @return\n * - A positive value lower or equal to size: success. The return value\n * is the number of entries filled in the stats table.\n- * - A positive value higher than size: error, the given statistics table\n+ * - A positive value higher than size: success: The given statistics table\n * is too small. The return value corresponds to the size that should\n * be given to succeed. The entries in the table are not valid and\n * shall not be used by the caller.\n- * - A negative value on error (invalid port id).\n+ * - A negative value on error.\n */\n int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids,\n \t\t\t uint64_t *values, unsigned int size);\n", "prefixes": [ "v7", "1/5" ] }