Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/135998/?format=api
{ "id": 135998, "url": "http://patches.dpdk.org/api/patches/135998/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20240119174346.108905-7-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": "<20240119174346.108905-7-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240119174346.108905-7-bruce.richardson@intel.com", "date": "2024-01-19T17:43:41", "name": "[v2,06/11] eventdev: improve doxygen comments on configure struct", "commit_ref": null, "pull_url": null, "state": "changes-requested", "archived": true, "hash": "3fc1b5cd84fa28f9c2e9e7a7d65f90214e4a83c6", "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/20240119174346.108905-7-bruce.richardson@intel.com/mbox/", "series": [ { "id": 30860, "url": "http://patches.dpdk.org/api/series/30860/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30860", "date": "2024-01-19T17:43:35", "name": "improve eventdev API specification/documentation", "version": 2, "mbox": "http://patches.dpdk.org/series/30860/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/135998/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/135998/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 230FB43901;\n\tFri, 19 Jan 2024 18:44:51 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 78D8E42DE9;\n\tFri, 19 Jan 2024 18:44:15 +0100 (CET)", "from mgamail.intel.com (mgamail.intel.com [192.198.163.12])\n by mails.dpdk.org (Postfix) with ESMTP id 71D7A42DDD\n for <dev@dpdk.org>; Fri, 19 Jan 2024 18:44:13 +0100 (CET)", "from orsmga006.jf.intel.com ([10.7.209.51])\n by fmvoesa106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 19 Jan 2024 09:44:13 -0800", "from silpixa00400957.ir.intel.com (HELO\n silpixa00401385.ir.intel.com) ([10.237.214.26])\n by orsmga006.jf.intel.com with ESMTP; 19 Jan 2024 09:44:10 -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=1705686254; x=1737222254;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=VdnUqDrGM2/e2tMufxjZ0eJYKdinvpliMXZWcxc2voM=;\n b=Mv6exfC/1RXOXeapUr9mI29Kq2+9XjyBw/195sMdSD7EYm69dYkCGVcw\n PiRQ9ewWO9+WP0dJbQvxc12YnrgsFX0Mgbjgrvpnq9vGbNGarKUYAYYNI\n Vrk3Zxs+wavRXhfPAN3StNTEzzH6wf8tYyoI6AhunymKrM8aoTEJQfWWy\n RU28rQ9/dg7hR4Jm8wJkKCxWTV3xt76hRYI+Tbe3L38O9HuAWLCDWoD4u\n IPWgMTDABgh5PTnHp291XG1G8dPvWv4paCkKM8sAJuSFFW6wULBEBW4GI\n dIVjEBThZoMtcuYASiyYjWfAQdN4iqDxfuPMKJG6zaLIjUPpdA4dvI2j0 A==;", "X-IronPort-AV": [ "E=McAfee;i=\"6600,9927,10957\"; a=\"683713\"", "E=Sophos;i=\"6.05,204,1701158400\";\n d=\"scan'208\";a=\"683713\"", "E=McAfee;i=\"6600,9927,10957\"; a=\"761177790\"", "E=Sophos;i=\"6.05,204,1701158400\"; d=\"scan'208\";a=\"761177790\"" ], "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org", "Cc": "jerinj@marvell.com, mattias.ronnblom@ericsson.com,\n abdullah.sevincer@intel.com, sachin.saxena@oss.nxp.com,\n hemant.agrawal@nxp.com, pbhagavatula@marvell.com, pravin.pathak@intel.com,\n Bruce Richardson <bruce.richardson@intel.com>", "Subject": "[PATCH v2 06/11] eventdev: improve doxygen comments on configure\n struct", "Date": "Fri, 19 Jan 2024 17:43:41 +0000", "Message-Id": "<20240119174346.108905-7-bruce.richardson@intel.com>", "X-Mailer": "git-send-email 2.40.1", "In-Reply-To": "<20240119174346.108905-1-bruce.richardson@intel.com>", "References": "<20240118134557.73172-1-bruce.richardson@intel.com>\n <20240119174346.108905-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 rewording and cleanup on the rte_event_dev_config structure.\nImproved the wording of some sentences and created linked\ncross-references out of the existing references to the dev_info\nstructure.\n\nSigned-off-by: Bruce Richardson <bruce.richardson@intel.com>\n---\n lib/eventdev/rte_eventdev.h | 47 +++++++++++++++++++------------------\n 1 file changed, 24 insertions(+), 23 deletions(-)", "diff": "diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h\nindex c57c93a22e..4139ccb982 100644\n--- a/lib/eventdev/rte_eventdev.h\n+++ b/lib/eventdev/rte_eventdev.h\n@@ -599,9 +599,9 @@ rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id,\n struct rte_event_dev_config {\n \tuint32_t dequeue_timeout_ns;\n \t/**< rte_event_dequeue_burst() timeout on this device.\n-\t * This value should be in the range of *min_dequeue_timeout_ns* and\n-\t * *max_dequeue_timeout_ns* which previously provided in\n-\t * rte_event_dev_info_get()\n+\t * This value should be in the range of @ref rte_event_dev_info.min_dequeue_timeout_ns and\n+\t * @ref rte_event_dev_info.max_dequeue_timeout_ns returned by\n+\t * @ref rte_event_dev_info_get()\n \t * The value 0 is allowed, in which case, default dequeue timeout used.\n \t * @see RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT\n \t */\n@@ -609,40 +609,41 @@ struct rte_event_dev_config {\n \t/**< In a *closed system* this field is the limit on maximum number of\n \t * events that can be inflight in the eventdev at a given time. The\n \t * limit is required to ensure that the finite space in a closed system\n-\t * is not overwhelmed. The value cannot exceed the *max_num_events*\n-\t * as provided by rte_event_dev_info_get().\n+\t * is not overwhelmed.\n+\t * Once the limit has been reached, any enqueues of NEW events to the\n+\t * system will fail.\n+\t * The value cannot exceed @ref rte_event_dev_info.max_num_events\n+\t * returned by rte_event_dev_info_get().\n \t * This value should be set to -1 for *open system*.\n \t */\n \tuint8_t nb_event_queues;\n \t/**< Number of event queues to configure on this device.\n-\t * This value cannot exceed the *max_event_queues* which previously\n-\t * provided in rte_event_dev_info_get()\n+\t * This value cannot exceed @ref rte_event_dev_info.max_event_queues\n+\t * returned by rte_event_dev_info_get()\n \t */\n \tuint8_t nb_event_ports;\n \t/**< Number of event ports to configure on this device.\n-\t * This value cannot exceed the *max_event_ports* which previously\n-\t * provided in rte_event_dev_info_get()\n+\t * This value cannot exceed @ref rte_event_dev_info.max_event_ports\n+\t * returned by rte_event_dev_info_get()\n \t */\n \tuint32_t nb_event_queue_flows;\n-\t/**< Number of flows for any event queue on this device.\n-\t * This value cannot exceed the *max_event_queue_flows* which previously\n-\t * provided in rte_event_dev_info_get()\n+\t/**< Max number of flows needed for a single event queue on this device.\n+\t * This value cannot exceed @ref rte_event_dev_info.max_event_queue_flows\n+\t * returned by rte_event_dev_info_get()\n \t */\n \tuint32_t nb_event_port_dequeue_depth;\n-\t/**< Maximum number of events can be dequeued at a time from an\n-\t * event port by this device.\n-\t * This value cannot exceed the *max_event_port_dequeue_depth*\n-\t * which previously provided in rte_event_dev_info_get().\n+\t/**< Max number of events that can be dequeued at a time from an event port on this device.\n+\t * This value cannot exceed @ref rte_event_dev_info.max_event_port_dequeue_depth\n+\t * returned by rte_event_dev_info_get().\n \t * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable.\n-\t * @see rte_event_port_setup()\n+\t * @see rte_event_port_setup() rte_event_dequeue_burst()\n \t */\n \tuint32_t nb_event_port_enqueue_depth;\n-\t/**< Maximum number of events can be enqueued at a time from an\n-\t * event port by this device.\n-\t * This value cannot exceed the *max_event_port_enqueue_depth*\n-\t * which previously provided in rte_event_dev_info_get().\n+\t/**< Maximum number of events can be enqueued at a time to an event port on this device.\n+\t * This value cannot exceed @ref rte_event_dev_info.max_event_port_enqueue_depth\n+\t * returned by rte_event_dev_info_get().\n \t * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable.\n-\t * @see rte_event_port_setup()\n+\t * @see rte_event_port_setup() rte_event_enqueue_burst()\n \t */\n \tuint32_t event_dev_cfg;\n \t/**< Event device config flags(RTE_EVENT_DEV_CFG_)*/\n@@ -652,7 +653,7 @@ struct rte_event_dev_config {\n \t * queues; this value cannot exceed *nb_event_ports* or\n \t * *nb_event_queues*. If the device has ports and queues that are\n \t * optimized for single-link usage, this field is a hint for how many\n-\t * to allocate; otherwise, regular event ports and queues can be used.\n+\t * to allocate; otherwise, regular event ports and queues will be used.\n \t */\n };\n \n", "prefixes": [ "v2", "06/11" ] }