Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/135958/?format=api
{ "id": 135958, "url": "http://patches.dpdk.org/api/patches/135958/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20240118134557.73172-6-bruce.richardson@intel.com/", "project": { "id": 1, "url": "http://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": "<20240118134557.73172-6-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240118134557.73172-6-bruce.richardson@intel.com", "date": "2024-01-18T13:45:55", "name": "[v1,5/7] eventdev: improve function documentation for query fns", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "9ddf2da7261407dab70f4f1239418a2e0c20d608", "submitter": { "id": 20, "url": "http://patches.dpdk.org/api/people/20/?format=api", "name": "Bruce Richardson", "email": "bruce.richardson@intel.com" }, "delegate": { "id": 310, "url": "http://patches.dpdk.org/api/users/310/?format=api", "username": "jerin", "first_name": "Jerin", "last_name": "Jacob", "email": "jerinj@marvell.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20240118134557.73172-6-bruce.richardson@intel.com/mbox/", "series": [ { "id": 30838, "url": "http://patches.dpdk.org/api/series/30838/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30838", "date": "2024-01-18T13:45:50", "name": "improve eventdev API specification/documentation", "version": 1, "mbox": "http://patches.dpdk.org/series/30838/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/135958/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/135958/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 7E9B6438F3;\n\tThu, 18 Jan 2024 14:46:52 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id F1D0242DA3;\n\tThu, 18 Jan 2024 14:46:23 +0100 (CET)", "from mgamail.intel.com (mgamail.intel.com [198.175.65.13])\n by mails.dpdk.org (Postfix) with ESMTP id 877EE42DAC\n for <dev@dpdk.org>; Thu, 18 Jan 2024 14:46:20 +0100 (CET)", "from orsmga003.jf.intel.com ([10.7.209.27])\n by orvoesa105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 18 Jan 2024 05:46:20 -0800", "from silpixa00400957.ir.intel.com (HELO\n silpixa00401385.ir.intel.com) ([10.237.214.26])\n by orsmga003.jf.intel.com with ESMTP; 18 Jan 2024 05:46:18 -0800" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n d=intel.com; i=@intel.com; q=dns/txt; s=Intel;\n t=1705585581; x=1737121581;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=L5m5miMiYE21agROvRXl0A3v7/+usNFxKwe9mRepIpA=;\n b=RuJz57X1IiEHTxfAXLV2jG8OHQYROuYJC4OUlp432/pk9BFDAkSqWboC\n pAbuwAR/n29rSDTzhoM12WRx/x2fnlrvUlezblYcvO/bVJ53V6zL0JP3A\n kFeWwQLeWHxNJkLBzOOzn+tFq2InYmCtc0/Jm8W2Mm1sN6ltxtY7P3s3i\n qZEGJEZ8bDhAva83ss1VKntBmUXssvCZ4zhYnim62hUt5oZDuz+5seB9g\n qRBp7jog+M2mlbqcfiwZSB+qx/iINpAq6SBHGZxkUhhIeW5Y1YqK8lvKB\n 2lpuEXHwWnGvHy1Ud+rLUEtYs2CrBZzpF5D2R0Zsu46OZCWgFR0VLXF8l A==;", "X-IronPort-AV": [ "E=McAfee;i=\"6600,9927,10956\"; a=\"7542795\"", "E=Sophos;i=\"6.05,201,1701158400\";\n d=\"scan'208\";a=\"7542795\"", "E=McAfee;i=\"6600,9927,10956\"; a=\"734274148\"", "E=Sophos;i=\"6.05,201,1701158400\"; d=\"scan'208\";a=\"734274148\"" ], "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org", "Cc": "Bruce Richardson <bruce.richardson@intel.com>,\n Jerin Jacob <jerinj@marvell.com>", "Subject": "[PATCH v1 5/7] eventdev: improve function documentation for query fns", "Date": "Thu, 18 Jan 2024 13:45:55 +0000", "Message-Id": "<20240118134557.73172-6-bruce.richardson@intel.com>", "X-Mailer": "git-send-email 2.40.1", "In-Reply-To": "<20240118134557.73172-1-bruce.richardson@intel.com>", "References": "<20240118134557.73172-1-bruce.richardson@intel.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "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" }, "content": "General improvements to the doxygen docs for eventdev functions for\nquerying basic information:\n* number of devices\n* id for a particular device\n* socket id of device\n* capability information for a device\n\nSigned-off-by: Bruce Richardson <bruce.richardson@intel.com>\n---\n lib/eventdev/rte_eventdev.h | 22 +++++++++++++---------\n 1 file changed, 13 insertions(+), 9 deletions(-)", "diff": "diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h\nindex 872f241df2..c57c93a22e 100644\n--- a/lib/eventdev/rte_eventdev.h\n+++ b/lib/eventdev/rte_eventdev.h\n@@ -440,8 +440,7 @@ struct rte_event;\n */\n \n /**\n- * Get the total number of event devices that have been successfully\n- * initialised.\n+ * Get the total number of event devices available for application use.\n *\n * @return\n * The total number of usable event devices.\n@@ -456,8 +455,10 @@ rte_event_dev_count(void);\n * Event device name to select the event device identifier.\n *\n * @return\n- * Returns event device identifier on success.\n- * - <0: Failure to find named event device.\n+ * Event device identifier (dev_id >= 0) on success.\n+ * Negative error code on failure:\n+ * - -EINVAL - input name parameter is invalid\n+ * - -ENODEV - no event device found with that name\n */\n int\n rte_event_dev_get_dev_id(const char *name);\n@@ -470,7 +471,8 @@ rte_event_dev_get_dev_id(const char *name);\n * @return\n * The NUMA socket id to which the device is connected or\n * a default of zero if the socket could not be determined.\n- * -(-EINVAL) dev_id value is out of range.\n+ * -EINVAL on error, where the given dev_id value does not\n+ * correspond to any event device.\n */\n int\n rte_event_dev_socket_id(uint8_t dev_id);\n@@ -539,18 +541,20 @@ struct rte_event_dev_info {\n };\n \n /**\n- * Retrieve the contextual information of an event device.\n+ * Retrieve details of an event device's capabilities and configuration limits.\n *\n * @param dev_id\n * The identifier of the device.\n *\n * @param[out] dev_info\n * A pointer to a structure of type *rte_event_dev_info* to be filled with the\n- * contextual information of the device.\n+ * information about the device's capabilities.\n *\n * @return\n- * - 0: Success, driver updates the contextual information of the event device\n- * - <0: Error code returned by the driver info get function.\n+ * - 0: Success, information about the event device is present in dev_info.\n+ * - <0: Failure, error code returned by the function.\n+ * - -EINVAL - invalid input parameters, e.g. incorrect device id\n+ * - -ENOTSUP - device does not support returning capabilities information\n */\n int\n rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info);\n", "prefixes": [ "v1", "5/7" ] }