Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/87045/?format=api
{ "id": 87045, "url": "http://patches.dpdk.org/api/patches/87045/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20210121231533.381590-1-thomas@monjalon.net/", "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": "<20210121231533.381590-1-thomas@monjalon.net>", "list_archive_url": "https://inbox.dpdk.org/dev/20210121231533.381590-1-thomas@monjalon.net", "date": "2021-01-21T23:15:32", "name": "[1/1] lib: fix doxygen for parameters of function pointers", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "41f3b575238fdc5485e4394162ab016050ea3a65", "submitter": { "id": 685, "url": "http://patches.dpdk.org/api/people/685/?format=api", "name": "Thomas Monjalon", "email": "thomas@monjalon.net" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20210121231533.381590-1-thomas@monjalon.net/mbox/", "series": [ { "id": 14894, "url": "http://patches.dpdk.org/api/series/14894/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=14894", "date": "2021-01-21T23:15:32", "name": "[1/1] lib: fix doxygen for parameters of function pointers", "version": 1, "mbox": "http://patches.dpdk.org/series/14894/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/87045/comments/", "check": "fail", "checks": "http://patches.dpdk.org/api/patches/87045/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 B0EBAA0A0A;\n\tFri, 22 Jan 2021 00:21:13 +0100 (CET)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 9B02F140D38;\n\tFri, 22 Jan 2021 00:21:13 +0100 (CET)", "from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com\n [66.111.4.27]) by mails.dpdk.org (Postfix) with ESMTP id 1C540140D0A;\n Fri, 22 Jan 2021 00:21:12 +0100 (CET)", "from compute2.internal (compute2.nyi.internal [10.202.2.42])\n by mailout.nyi.internal (Postfix) with ESMTP id 82E0B5C018F;\n Thu, 21 Jan 2021 18:21:11 -0500 (EST)", "from mailfrontend2 ([10.202.2.163])\n by compute2.internal (MEProxy); Thu, 21 Jan 2021 18:21:11 -0500", "from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184])\n by mail.messagingengine.com (Postfix) with ESMTPA id 0CA831080063;\n Thu, 21 Jan 2021 18:21:09 -0500 (EST)" ], "DKIM-Signature": [ "v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h=\n from:to:cc:subject:date:message-id:mime-version\n :content-transfer-encoding; s=fm3; bh=8VVi86cpSZWu4cmn1OYGw796QT\n wfvmn1l//m3tjFaEw=; b=UtgknRZUR5LvpdJNDp3KMcUuEJz1M5vhJBsoroNrwl\n zvD0OFicEboSdXg5sXp+C0TgGzc9y4r1X5ObgyGEkJfNPsAHLXV2A3B4zJ6v2Pij\n d4c/Ltg2B3OqPEFyUlEHGyZpibFmJfr/t8c3VKFpKcWuGmxl4D8+g/4s2BSH02Kz\n sEWLPm+0XyggOH2g6i6IsPpzS55wwiGYemJSH70jUCCvFApNin8ZUhjkoR8Zz1uw\n LJd/LYxJIkO/yXzxJigRws9SLg7LyO2twXP9jLwNYoT/vzSnSQMZODwmCXGjAc2F\n FtHyxN61GrKHr7SNmQWgAhQyK3tTKraS2QKlOF2lKuMA==", "v=1; a=rsa-sha256; c=relaxed/relaxed; d=\n messagingengine.com; h=cc:content-transfer-encoding:date:from\n :message-id:mime-version:subject:to:x-me-proxy:x-me-proxy\n :x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=8VVi86cpSZWu4cmn1\n OYGw796QTwfvmn1l//m3tjFaEw=; b=WQllKlFepOfRT96UAVffmPO+IfUSMIATP\n 0nR6UnLFCv5QZciwOyPSBis5K+jDREah/zx1ZKKYwUU6lmMkE0njQJOLfWT2MtWs\n 92jNjmSjrIK5Xtw8g2ZdlR3orRUJbDzEJfLUSs2vFR25ZGgNBqtT4dZZicoNaYcT\n cC+84LG1ZQTH3lfu5/85lf4NPyUsbj1iJG6oL1fYD4pBzGCuY4oCwnh0vByNexhj\n H+p0kKBHaGr7EnKO7CFJQxY10vNrl4RQybeA/aG8apS/lhtGDzyrGa/c17wefGO5\n C3jivoUr2HodZe4hNwTNfd966a1YTNkOBvTX+ldoObEhEGQ22dcBA==" ], "X-ME-Sender": "<xms:ZwwKYELF4ih7BUvBzDyaS8c-7Ef8lUVMA0eOq39mm7kfR40Kjr575A>\n <xme:ZwwKYEJllYJAzRVJmoaOvVExvOy2nBTuFxm9PUMaYXCMF1Gc99oxnr6Fwm81NOOZC\n hLCCOtIK-PrMgLF5Q>", "X-ME-Proxy-Cause": "\n gggruggvucftvghtrhhoucdtuddrgeduledrudehgddtlecutefuodetggdotefrodftvf\n curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu\n uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc\n fjughrpefhvffufffkofgggfestdekredtredttdenucfhrhhomhepvfhhohhmrghsucfo\n ohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenucggtffrrg\n htthgvrhhnpefgueefjeetudfgveettdekvdekteefieffieevgeehjeevtdehveeigfff\n uefhieenucffohhmrghinhepghhithhhuhgsrdgtohhmnecukfhppeejjedrudefgedrvd\n dtfedrudekgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhr\n ohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght", "X-ME-Proxy": "<xmx:ZwwKYEvBzV4_Mq507eVD3-NxIxEeWNSVu3kC1EteiW90xgtwcGoHNQ>\n <xmx:ZwwKYBYbTLmSxBZ9B_hXEE4_YGdZhD8PyYdzAe-nQ1qZRqbD1i9YRg>\n <xmx:ZwwKYLYQSY5c5zNeOFHLGeJZKEt-CZmD11yVlA4msWipRBH45IFOBQ>\n <xmx:ZwwKYP7DCufcJNBFmvul_4ThFTtB7EfjX13oNR_jwxi2AIa-1ichIg>", "From": "Thomas Monjalon <thomas@monjalon.net>", "To": "dev@dpdk.org", "Cc": "stable@dpdk.org, Fiona Trahe <fiona.trahe@intel.com>,\n Ashish Gupta <ashish.gupta@marvell.com>,\n Declan Doherty <declan.doherty@intel.com>,\n Jerin Jacob <jerinj@marvell.com>,\n Cristian Dumitrescu <cristian.dumitrescu@intel.com>,\n Nipun Gupta <nipun.gupta@nxp.com>, Hemant Agrawal <hemant.agrawal@nxp.com>,\n Akhil Goyal <akhil.goyal@nxp.com>", "Date": "Fri, 22 Jan 2021 00:15:32 +0100", "Message-Id": "<20210121231533.381590-1-thomas@monjalon.net>", "X-Mailer": "git-send-email 2.30.0", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[dpdk-dev] [PATCH 1/1] lib: fix doxygen for parameters of function\n pointers", "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": "Some parameters of typedef'ed function pointers were not properly listed\nin the doxygen comments.\nThe error is seen with doxygen 1.9 which added this specific check:\n\thttps://github.com/doxygen/doxygen/commit/d34236ba4037\n\nCc: stable@dpdk.org\n\nSigned-off-by: Thomas Monjalon <thomas@monjalon.net>\n---\n lib/librte_compressdev/rte_compressdev_pmd.h | 2 ++\n lib/librte_cryptodev/rte_cryptodev_pmd.h | 12 ++++++------\n lib/librte_eal/include/rte_keepalive.h | 2 +-\n lib/librte_eventdev/rte_eventdev_pmd.h | 12 +++++++++++-\n lib/librte_port/rte_port.h | 2 +-\n lib/librte_port/rte_swx_port.h | 4 ++--\n lib/librte_rawdev/rte_rawdev_pmd.h | 18 ++++++++++++------\n lib/librte_security/rte_security_driver.h | 7 ++++---\n lib/librte_table/rte_swx_table.h | 6 ------\n lib/librte_table/rte_table.h | 4 ++--\n 10 files changed, 41 insertions(+), 28 deletions(-)", "diff": "diff --git a/lib/librte_compressdev/rte_compressdev_pmd.h b/lib/librte_compressdev/rte_compressdev_pmd.h\nindex d5898a5b71..52e64eab03 100644\n--- a/lib/librte_compressdev/rte_compressdev_pmd.h\n+++ b/lib/librte_compressdev/rte_compressdev_pmd.h\n@@ -138,6 +138,8 @@ typedef void (*compressdev_stats_reset_t)(struct rte_compressdev *dev);\n *\n * @param dev\n * Compress device\n+ * @param dev_info\n+ * Compress device informations to populate\n */\n typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev,\n \t\t\t\tstruct rte_compressdev_info *dev_info);\ndiff --git a/lib/librte_cryptodev/rte_cryptodev_pmd.h b/lib/librte_cryptodev/rte_cryptodev_pmd.h\nindex 9a8a7e632b..1274436870 100644\n--- a/lib/librte_cryptodev/rte_cryptodev_pmd.h\n+++ b/lib/librte_cryptodev/rte_cryptodev_pmd.h\n@@ -121,7 +121,7 @@ extern struct rte_cryptodev *rte_cryptodevs;\n *\tFunction used to configure device.\n *\n * @param\tdev\tCrypto device pointer\n- *\t\tconfig\tCrypto device configurations\n+ * @param\tconfig\tCrypto device configurations\n *\n * @return\tReturns 0 on success\n */\n@@ -176,7 +176,8 @@ typedef void (*cryptodev_stats_reset_t)(struct rte_cryptodev *dev);\n /**\n * Function used to get specific information of a device.\n *\n- * @param\tdev\tCrypto device pointer\n+ * @param\tdev\t\tCrypto device pointer\n+ * @param\tdev_info\tPointer to infos structure to populate\n */\n typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,\n \t\t\t\tstruct rte_cryptodev_info *dev_info);\n@@ -213,7 +214,7 @@ typedef int (*cryptodev_queue_pair_release_t)(struct rte_cryptodev *dev,\n *\n * @param\tdev\t\tCrypto device pointer\n * @param\tnb_objs\t\tnumber of sessions objects in mempool\n- * @param\tobj_cache\tl-core object cache size, see *rte_ring_create*\n+ * @param\tobj_cache_size\tl-core object cache size, see *rte_ring_create*\n * @param\tsocket_id\tSocket Id to allocate mempool on.\n *\n * @return\n@@ -253,7 +254,7 @@ typedef unsigned int (*cryptodev_asym_get_session_private_size_t)(\n *\n * @param\tdev\t\tCrypto device pointer\n * @param\txform\t\tSingle or chain of crypto xforms\n- * @param\tpriv_sess\tPointer to cryptodev's private session structure\n+ * @param\tsession\t\tPointer to cryptodev's private session structure\n * @param\tmp\t\tMempool where the private session is allocated\n *\n * @return\n@@ -271,7 +272,7 @@ typedef int (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,\n *\n * @param\tdev\t\tCrypto device pointer\n * @param\txform\t\tSingle or chain of crypto xforms\n- * @param\tpriv_sess\tPointer to cryptodev's private session structure\n+ * @param\tsession\t\tPointer to cryptodev's private session structure\n * @param\tmp\t\tMempool where the private session is allocated\n *\n * @return\n@@ -333,7 +334,6 @@ typedef int (*cryptodev_sym_get_raw_dp_ctx_size_t)(struct rte_cryptodev *dev);\n *\n * @param\tdev\t\tCrypto device pointer.\n * @param\tqp_id\t\tCrypto device queue pair index.\n- * @param\tservice_type\tType of the service requested.\n * @param\tctx\t\tThe raw data-path context data.\n * @param\tsess_type\tsession type.\n * @param\tsession_ctx\tSession context data. If NULL the driver\ndiff --git a/lib/librte_eal/include/rte_keepalive.h b/lib/librte_eal/include/rte_keepalive.h\nindex 4bda7ca56f..bd25508da8 100644\n--- a/lib/librte_eal/include/rte_keepalive.h\n+++ b/lib/librte_eal/include/rte_keepalive.h\n@@ -52,7 +52,7 @@ typedef void (*rte_keepalive_failure_callback_t)(\n * @param data Data pointer passed to rte_keepalive_register_relay_callback()\n * @param id_core ID of the core for which state is being reported\n * @param core_state The current state of the core\n- * @param Timestamp of when core was last seen alive\n+ * @param last_seen Timestamp of when core was last seen alive\n */\n typedef void (*rte_keepalive_relay_callback_t)(\n \tvoid *data,\ndiff --git a/lib/librte_eventdev/rte_eventdev_pmd.h b/lib/librte_eventdev/rte_eventdev_pmd.h\nindex 27be376ed1..9e83993efa 100644\n--- a/lib/librte_eventdev/rte_eventdev_pmd.h\n+++ b/lib/librte_eventdev/rte_eventdev_pmd.h\n@@ -297,7 +297,7 @@ typedef void (*eventdev_port_release_t)(void *port);\n * Event device pointer\n * @param port\n * Event port pointer\n- * @param link\n+ * @param queues\n * Points to an array of *nb_links* event queues to be linked\n * to the event port.\n * @param priorities\n@@ -383,6 +383,10 @@ typedef void (*eventdev_dump_t)(struct rte_eventdev *dev, FILE *f);\n *\n * @param dev\n * Event device pointer\n+ * @param mode\n+ * Level (device, port or queue)\n+ * @param queue_port_id\n+ * Queue or port number depending on mode\n * @param ids\n * The stat ids to retrieve\n * @param values\n@@ -410,8 +414,14 @@ typedef int (*eventdev_xstats_reset_t)(struct rte_eventdev *dev,\n *\n * @param dev\n * Event device pointer\n+ * @param mode\n+ * Level (device, port or queue)\n+ * @param queue_port_id\n+ * Queue or port number depending on mode\n * @param xstats_names\n * Array of name values to be filled in\n+ * @param ids\n+ * The stat ids to retrieve\n * @param size\n * Number of values in the xstats_names array\n * @return\ndiff --git a/lib/librte_port/rte_port.h b/lib/librte_port/rte_port.h\nindex 7f156ef47d..6b6a2cdd17 100644\n--- a/lib/librte_port/rte_port.h\n+++ b/lib/librte_port/rte_port.h\n@@ -186,7 +186,7 @@ typedef int (*rte_port_out_op_tx)(\n */\n typedef int (*rte_port_out_op_tx_bulk)(\n \tvoid *port,\n-\tstruct rte_mbuf **pkt,\n+\tstruct rte_mbuf **pkts,\n \tuint64_t pkts_mask);\n \n /**\ndiff --git a/lib/librte_port/rte_swx_port.h b/lib/librte_port/rte_swx_port.h\nindex 4beb59991f..ecf109d2ca 100644\n--- a/lib/librte_port/rte_swx_port.h\n+++ b/lib/librte_port/rte_swx_port.h\n@@ -50,7 +50,7 @@ typedef void *\n /**\n * Input port free\n *\n- * @param[in] args\n+ * @param[in] port\n * Input port handle.\n */\n typedef void\n@@ -129,7 +129,7 @@ typedef void *\n /**\n * Output port free\n *\n- * @param[in] args\n+ * @param[in] port\n * Output port handle.\n */\n typedef void\ndiff --git a/lib/librte_rawdev/rte_rawdev_pmd.h b/lib/librte_rawdev/rte_rawdev_pmd.h\nindex 34dd7181b4..b1bed13ee2 100644\n--- a/lib/librte_rawdev/rte_rawdev_pmd.h\n+++ b/lib/librte_rawdev/rte_rawdev_pmd.h\n@@ -155,6 +155,8 @@ typedef int (*rawdev_info_get_t)(struct rte_rawdev *dev,\n * Raw device pointer\n * @param config\n * Void object containing device specific configuration\n+ * @param config_size\n+ * Size of the memory allocated for the configuration\n *\n * @return\n * Returns 0 on success\n@@ -214,6 +216,8 @@ typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);\n * Raw device queue index\n * @param[out] queue_conf\n * Raw device queue configuration structure\n+ * @param queue_conf_size\n+ * Size of the memory allocated for the configuration\n *\n * @return\n * Returns 0 on success, negative errno on failure\n@@ -232,6 +236,8 @@ typedef int (*rawdev_queue_conf_get_t)(struct rte_rawdev *dev,\n * Rawqueue index\n * @param queue_conf\n * Rawqueue configuration structure\n+ * @param queue_conf_size\n+ * Size of the memory allocated for the configuration\n *\n * @return\n * Returns 0 on success.\n@@ -263,7 +269,7 @@ typedef int (*rawdev_queue_release_t)(struct rte_rawdev *dev,\n * This function helps in getting queue count supported, independently. It\n * can help in cases where iterator needs to be implemented.\n *\n- * @param\n+ * @param dev\n * Raw device pointer\n * @return\n * Number of queues; 0 is assumed to be a valid response.\n@@ -279,7 +285,7 @@ typedef uint16_t (*rawdev_queue_count_t)(struct rte_rawdev *dev);\n *\n * @param dev\n * Raw device pointer\n- * @param bufs\n+ * @param buffers\n * array of buffers\n * @param count\n * number of buffers passed\n@@ -303,7 +309,7 @@ typedef int (*rawdev_enqueue_bufs_t)(struct rte_rawdev *dev,\n *\n * @param dev\n * Raw device pointer\n- * @param bufs\n+ * @param buffers\n * array of buffers\n * @param count\n * Max buffers expected to be dequeued\n@@ -444,7 +450,7 @@ typedef uint64_t (*rawdev_xstats_get_by_name_t)(const struct rte_rawdev *dev,\n *\n * @param dev\n * Raw device pointer\n- * @param status\n+ * @param status_info\n * void block containing device specific status information\n * @return\n * 0 for success,\n@@ -472,8 +478,8 @@ typedef int (*rawdev_firmware_version_get_t)(struct rte_rawdev *dev,\n *\n * @param dev\n * Raw device pointer\n- * @param firmware_file\n- * file pointer to firmware area\n+ * @param firmware_buf\n+ * Pointer to firmware image\n * @return\n * >0, ~0: for successful load\n * <0: for failure\ndiff --git a/lib/librte_security/rte_security_driver.h b/lib/librte_security/rte_security_driver.h\nindex c5abb07990..938373205c 100644\n--- a/lib/librte_security/rte_security_driver.h\n+++ b/lib/librte_security/rte_security_driver.h\n@@ -41,7 +41,7 @@ typedef int (*security_session_create_t)(void *device,\n /**\n * Free driver private session data.\n *\n- * @param\tdev\t\tCrypto/eth device pointer\n+ * @param\tdevice\t\tCrypto/eth device pointer\n * @param\tsess\t\tSecurity session structure\n */\n typedef int (*security_session_destroy_t)(void *device,\n@@ -95,16 +95,17 @@ int rte_security_dynfield_register(void);\n /**\n * Update the mbuf with provided metadata.\n *\n+ * @param\tdevice\t\tCrypto/eth device pointer\n * @param\tsess\t\tSecurity session structure\n * @param\tmb\t\tPacket buffer\n- * @param\tmt\t\tMetadata\n+ * @param\tparams\t\tMetadata\n *\n * @return\n * - Returns 0 if metadata updated successfully.\n * - Returns -ve value for errors.\n */\n typedef int (*security_set_pkt_metadata_t)(void *device,\n-\t\tstruct rte_security_session *sess, struct rte_mbuf *m,\n+\t\tstruct rte_security_session *sess, struct rte_mbuf *mb,\n \t\tvoid *params);\n \n /**\ndiff --git a/lib/librte_table/rte_swx_table.h b/lib/librte_table/rte_swx_table.h\nindex dc434b72ef..5a3137ec53 100644\n--- a/lib/librte_table/rte_swx_table.h\n+++ b/lib/librte_table/rte_swx_table.h\n@@ -127,12 +127,6 @@ typedef uint64_t\n * progress and it is passed as a parameter to the lookup operation. This allows\n * for multiple concurrent lookup operations into the same table.\n *\n- * @param[in] params\n- * Table creation parameters.\n- * @param[in] entries\n- * Entries to be added to the table at creation time.\n- * @param[in] args\n- * Any additional table create arguments. It may be NULL.\n * @return\n * Table memory footprint in bytes, on success, or zero, on error.\n */\ndiff --git a/lib/librte_table/rte_table.h b/lib/librte_table/rte_table.h\nindex cccded1a1c..096ab8a7c8 100644\n--- a/lib/librte_table/rte_table.h\n+++ b/lib/librte_table/rte_table.h\n@@ -129,7 +129,7 @@ typedef int (*rte_table_op_entry_delete)(\n *\n * @param table\n * Handle to lookup table instance\n- * @param key\n+ * @param keys\n * Array containing lookup keys\n * @param entries\n * Array containing data to be associated with each key. Every item in the\n@@ -166,7 +166,7 @@ typedef int (*rte_table_op_entry_add_bulk)(\n *\n * @param table\n * Handle to lookup table instance\n- * @param key\n+ * @param keys\n * Array containing lookup keys\n * @param n_keys\n * Number of keys to delete\n", "prefixes": [ "1/1" ] }