Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/136961/?format=api
{ "id": 136961, "url": "http://patches.dpdk.org/api/patches/136961/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20240221103221.933238-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": "<20240221103221.933238-6-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240221103221.933238-6-bruce.richardson@intel.com", "date": "2024-02-21T10:32:14", "name": "[v4,05/12] eventdev: improve function documentation for query fns", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "ecec5898520c4b5f88266a833745db640dcb2de7", "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/20240221103221.933238-6-bruce.richardson@intel.com/mbox/", "series": [ { "id": 31169, "url": "http://patches.dpdk.org/api/series/31169/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=31169", "date": "2024-02-21T10:32:09", "name": "improve eventdev API specification/documentation", "version": 4, "mbox": "http://patches.dpdk.org/series/31169/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/136961/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/136961/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 AC56243B61;\n\tWed, 21 Feb 2024 11:33:02 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 7BA8640E09;\n\tWed, 21 Feb 2024 11:32:39 +0100 (CET)", "from mgamail.intel.com (mgamail.intel.com [192.198.163.15])\n by mails.dpdk.org (Postfix) with ESMTP id 7891640DCB\n for <dev@dpdk.org>; Wed, 21 Feb 2024 11:32:36 +0100 (CET)", "from orviesa007.jf.intel.com ([10.64.159.147])\n by fmvoesa109.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 21 Feb 2024 02:32:36 -0800", "from silpixa00401385.ir.intel.com ([10.237.214.38])\n by orviesa007.jf.intel.com with ESMTP; 21 Feb 2024 02:32:35 -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=1708511557; x=1740047557;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=8ODRsJgg3p8zuDDukFfrcJG/OQ+7gPhkfTrFTgqw7HY=;\n b=cOm4TzDS37pknMw4+ZxrJr+eQvoOu1i6QnQ45sZLhE8/7wiCdqLXKvcr\n SlR8Ju8BGdOFQtD7iVcFXtZw8nTYPSLOL27KkLjEAxdrQhy0gEnSOaJ+M\n b34XY+nn0Lf2hYAst3FmzjV5xQrhmvUQUYPZzZEScPqwIE4/sY2Qt2B+p\n 60wT/rkFgfVh59dKWEYp0iK7LElow56tXC1AkueMsDYxGl5wZ3KaCJJ7m\n 6P3/uxTA7lB8bhMG+luaMYprkL+VBoZ4Z7IAZoy7eyroZe7viSFJVZU4x\n WA9esC6CQldo5AsdzNomkwH/iaR9CJO2fHRxaMhdPFoxVvfelBHiHib8I w==;", "X-IronPort-AV": [ "E=McAfee;i=\"6600,9927,10990\"; a=\"2800719\"", "E=Sophos;i=\"6.06,175,1705392000\";\n d=\"scan'208\";a=\"2800719\"", "E=Sophos;i=\"6.06,175,1705392000\";\n d=\"scan'208\";a=\"5393009\"" ], "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org,\n\tjerinj@marvell.com,\n\tmattias.ronnblom@ericsson.com", "Cc": "Bruce Richardson <bruce.richardson@intel.com>", "Subject": "[PATCH v4 05/12] eventdev: improve function documentation for query\n fns", "Date": "Wed, 21 Feb 2024 10:32:14 +0000", "Message-Id": "<20240221103221.933238-6-bruce.richardson@intel.com>", "X-Mailer": "git-send-email 2.40.1", "In-Reply-To": "<20240221103221.933238-1-bruce.richardson@intel.com>", "References": "<20240119174346.108905-1-bruce.richardson@intel.com>\n <20240221103221.933238-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---\nV3: minor changes following review\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 b9ec3fc45e..9d286168b1 100644\n--- a/lib/eventdev/rte_eventdev.h\n+++ b/lib/eventdev/rte_eventdev.h\n@@ -498,8 +498,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.\n *\n * @return\n * The total number of usable event devices.\n@@ -514,8 +513,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@@ -528,7 +529,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@@ -624,18 +626,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": [ "v4", "05/12" ] }