Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/26119/?format=api
{ "id": 26119, "url": "https://patches.dpdk.org/api/patches/26119/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20170630165140.59594-5-ferruh.yigit@intel.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": "<20170630165140.59594-5-ferruh.yigit@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20170630165140.59594-5-ferruh.yigit@intel.com", "date": "2017-06-30T16:51:24", "name": "[dpdk-dev,v9,04/20] ethtool: update header doxygen syntax", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "cc3b7f8c7643423d3876c435204276b7a638ece5", "submitter": { "id": 324, "url": "https://patches.dpdk.org/api/people/324/?format=api", "name": "Ferruh Yigit", "email": "ferruh.yigit@intel.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20170630165140.59594-5-ferruh.yigit@intel.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/26119/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/26119/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id EBD6A7CB4;\n\tFri, 30 Jun 2017 18:52:24 +0200 (CEST)", "from mga02.intel.com (mga02.intel.com [134.134.136.20])\n\tby dpdk.org (Postfix) with ESMTP id 619C3235\n\tfor <dev@dpdk.org>; Fri, 30 Jun 2017 18:52:03 +0200 (CEST)", "from orsmga004.jf.intel.com ([10.7.209.38])\n\tby orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t30 Jun 2017 09:51:58 -0700", "from silpixa00372839.ir.intel.com (HELO\n\tsilpixa00372839.ger.corp.intel.com) ([10.237.222.154])\n\tby orsmga004.jf.intel.com with ESMTP; 30 Jun 2017 09:51:48 -0700" ], "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.40,287,1496127600\"; d=\"scan'208\";a=\"103233209\"", "From": "Ferruh Yigit <ferruh.yigit@intel.com>", "To": "dev@dpdk.org", "Cc": "Ferruh Yigit <ferruh.yigit@intel.com>,\n\tStephen Hemminger <stephen@networkplumber.org>,\n\tBruce Richardson <bruce.richardson@intel.com>,\n\tAnatoly Burakov <anatoly.burakov@intel.com>", "Date": "Fri, 30 Jun 2017 17:51:24 +0100", "Message-Id": "<20170630165140.59594-5-ferruh.yigit@intel.com>", "X-Mailer": "git-send-email 2.13.0", "In-Reply-To": "<20170630165140.59594-1-ferruh.yigit@intel.com>", "References": "<20170621110651.75299-1-ferruh.yigit@intel.com>\n\t<20170630165140.59594-1-ferruh.yigit@intel.com>", "Subject": "[dpdk-dev] [PATCH v9 04/20] ethtool: update header doxygen syntax", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Minor corrections and doxygen syntax fixes on library header file.\n\nSigned-off-by: Ferruh Yigit <ferruh.yigit@intel.com>\n---\n lib/librte_ethtool/rte_ethtool.h | 57 +++++++++++++++++++++-------------------\n 1 file changed, 30 insertions(+), 27 deletions(-)", "diff": "diff --git a/lib/librte_ethtool/rte_ethtool.h b/lib/librte_ethtool/rte_ethtool.h\nindex 18f44404b..bcf20870c 100644\n--- a/lib/librte_ethtool/rte_ethtool.h\n+++ b/lib/librte_ethtool/rte_ethtool.h\n@@ -34,11 +34,13 @@\n #ifndef _RTE_ETHTOOL_H_\n #define _RTE_ETHTOOL_H_\n \n-/*\n+/**\n+ * @file\n+ *\n * This new interface is designed to provide a user-space shim layer for\n * Ethtool and Netdevice op API.\n *\n- * rte_ethtool_get_driver: ethtool_ops::get_driverinfo\n+ * rte_ethtool_get_drvinfo: ethtool_ops::get_driverinfo\n * rte_ethtool_get_link: ethtool_ops::get_link\n * rte_ethtool_get_regs_len: ethtool_ops::get_regs_len\n * rte_ethtool_get_regs: ethtool_ops::get_regs\n@@ -47,6 +49,8 @@\n * rte_ethtool_set_eeprom: ethtool_ops::set_eeprom\n * rte_ethtool_get_pauseparam: ethtool_ops::get_pauseparam\n * rte_ethtool_set_pauseparam: ethtool_ops::set_pauseparam\n+ * rte_ethtool_get_ringparam: ethtool_ops::set_ringparam\n+ * rte_ethtool_set_ringparam: ethtool_ops::set_ringparam\n *\n * rte_ethtool_net_open: net_device_ops::ndo_open\n * rte_ethtool_net_stop: net_device_ops::ndo_stop\n@@ -101,7 +105,7 @@ int rte_ethtool_get_regs_len(uint8_t port_id);\n *\n * @param port_id\n * The port identifier of the Ethernet device.\n- * @param reg\n+ * @param regs\n * A pointer to ethtool_regs that has register information\n * @param data\n * A pointer to a buffer that is used to retrieve device register content\n@@ -112,7 +116,7 @@ int rte_ethtool_get_regs_len(uint8_t port_id);\n * - others depends on the specific operations implementation.\n */\n int rte_ethtool_get_regs(uint8_t port_id, struct ethtool_regs *regs,\n-\t\t\t void *data);\n+\t\tvoid *data);\n \n /**\n * Retrieve the Ethernet device link status\n@@ -135,7 +139,7 @@ int rte_ethtool_get_link(uint8_t port_id);\n * @param port_id\n * The port identifier of the Ethernet device.\n * @return\n- *\t - (> 0) device EEPROM size in bytes\n+ * - (> 0) device EEPROM size in bytes\n * - (0) device has NO EEPROM\n * - (-ENOTSUP) if hardware doesn't support.\n * - (-ENODEV) if *port_id* invalid.\n@@ -150,9 +154,9 @@ int rte_ethtool_get_eeprom_len(uint8_t port_id);\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param eeprom\n- *\t The pointer of ethtool_eeprom that provides eeprom range\n+ * The pointer of ethtool_eeprom that provides eeprom range\n * @param words\n- *\t A buffer that holds data read from eeprom\n+ * A buffer that holds data read from eeprom\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -160,7 +164,7 @@ int rte_ethtool_get_eeprom_len(uint8_t port_id);\n * - others depends on the specific operations implementation.\n */\n int rte_ethtool_get_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom,\n-\t\t\t void *words);\n+\t\tvoid *words);\n \n /**\n * Setting EEPROM content based upon eeprom range described in ethtool\n@@ -169,9 +173,9 @@ int rte_ethtool_get_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom,\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param eeprom\n- *\t The pointer of ethtool_eeprom that provides eeprom range\n+ * The pointer of ethtool_eeprom that provides eeprom range\n * @param words\n- *\t A buffer that holds data to be written into eeprom\n+ * A buffer that holds data to be written into eeprom\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -180,7 +184,7 @@ int rte_ethtool_get_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom,\n * - others depends on the specific operations implementation.\n */\n int rte_ethtool_set_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom,\n-\t\t\t void *words);\n+\t\tvoid *words);\n \n /**\n * Retrieve the Ethernet device pause frame configuration according to\n@@ -190,8 +194,8 @@ int rte_ethtool_set_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom,\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param pause_param\n- *\t The pointer of ethtool_coalesce that gets pause frame\n- *\t configuration parameters\n+ * The pointer of ethtool_coalesce that gets pause frame\n+ * configuration parameters\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -200,7 +204,7 @@ int rte_ethtool_set_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom,\n * - others depends on the specific operations implementation.\n */\n int rte_ethtool_get_pauseparam(uint8_t port_id,\n-\t\t\t\t struct ethtool_pauseparam *pause_param);\n+\t\tstruct ethtool_pauseparam *pause_param);\n \n /**\n * Setting the Ethernet device pause frame configuration according to\n@@ -208,8 +212,8 @@ int rte_ethtool_get_pauseparam(uint8_t port_id,\n *\n * @param port_id\n * The port identifier of the Ethernet device.\n- * @param pause_param\n- *\t The pointer of ethtool_coalesce that gets ring configuration parameters\n+ * @param param\n+ * The pointer of ethtool_coalesce that gets ring configuration parameters\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -218,7 +222,7 @@ int rte_ethtool_get_pauseparam(uint8_t port_id,\n * - others depends on the specific operations implementation.\n */\n int rte_ethtool_set_pauseparam(uint8_t port_id,\n-\t\t\t\t struct ethtool_pauseparam *param);\n+\t\tstruct ethtool_pauseparam *param);\n \n /**\n * Start the Ethernet device.\n@@ -250,7 +254,7 @@ int rte_ethtool_net_stop(uint8_t port_id);\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param addr\n- *\t MAC address of the Ethernet device.\n+ * MAC address of the Ethernet device.\n * @return\n * - (0) if successful.\n * - (-ENODEV) if *port_id* invalid.\n@@ -263,7 +267,7 @@ int rte_ethtool_net_get_mac_addr(uint8_t port_id, struct ether_addr *addr);\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param addr\n- *\t The new MAC addr.\n+ * The new MAC addr.\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -279,7 +283,7 @@ int rte_ethtool_net_set_mac_addr(uint8_t port_id, struct ether_addr *addr);\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param addr\n- *\t A pointer to a buffer (6-byte, 48bit) for the target MAC address\n+ * A pointer to a buffer (6-byte, 48bit) for the target MAC address\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -295,7 +299,7 @@ int rte_ethtool_net_validate_addr(uint8_t port_id, struct ether_addr *addr);\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param mtu\n- *\t New MTU\n+ * New MTU\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -311,7 +315,7 @@ int rte_ethtool_net_change_mtu(uint8_t port_id, int mtu);\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param stats\n- *\t A pointer to struct rte_eth_stats for statistics parameters\n+ * A pointer to struct rte_eth_stats for statistics parameters\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -327,7 +331,7 @@ int rte_ethtool_net_get_stats64(uint8_t port_id, struct rte_eth_stats *stats);\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param vid\n- *\t A new VLAN id\n+ * A new VLAN id\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -342,7 +346,7 @@ int rte_ethtool_net_vlan_rx_add_vid(uint8_t port_id, uint16_t vid);\n * @param port_id\n * The port identifier of the Ethernet device.\n * @param vid\n- *\t A new VLAN id\n+ * A new VLAN id\n * @return\n * - (0) if successful.\n * - (-ENOTSUP) if hardware doesn't support.\n@@ -381,7 +385,7 @@ int rte_ethtool_net_set_rx_mode(uint8_t port_id);\n * are used, and the function only gets parameters for queue 0.\n */\n int rte_ethtool_get_ringparam(uint8_t port_id,\n-\tstruct ethtool_ringparam *ring_param);\n+\t\tstruct ethtool_ringparam *ring_param);\n \n /**\n * Setting ring parameters for Ethernet device.\n@@ -400,8 +404,7 @@ int rte_ethtool_get_ringparam(uint8_t port_id,\n * are used, and the function only sets parameters for queue 0.\n */\n int rte_ethtool_set_ringparam(uint8_t port_id,\n-\tstruct ethtool_ringparam *ring_param);\n-\n+\t\tstruct ethtool_ringparam *ring_param);\n \n #ifdef __cplusplus\n }\n", "prefixes": [ "dpdk-dev", "v9", "04/20" ] }