patch 'power: fix some doxygen comments' has been queued to stable release 20.11.7

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 20.11.7

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 11/19/22. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable/commit/76c23eded561afb5899cbbe8155e49bddf756204

Thanks.

Luca Boccassi

---
>From 76c23eded561afb5899cbbe8155e49bddf756204 Mon Sep 17 00:00:00 2001
From: Jerin Jacob <jerinj at marvell.com>
Date: Wed, 9 Nov 2022 20:24:10 +0530
Subject: [PATCH] power: fix some doxygen comments

[ upstream commit 58794bf8d2d577b18e8bd430fd6419274678b34e ]

Fix following syntax error reported by doxygen 1.9.5 version.

lib/power/rte_power.h:169: error: rte_power_freq_up has
@param documentation sections but no arguments
(warning treated as error, aborting now)

Fixes: d7937e2e3d12 ("power: initial import")

Signed-off-by: Jerin Jacob <jerinj at marvell.com>
---
 lib/librte_power/rte_power.h | 55 ------------------------------------
 1 file changed, 55 deletions(-)

diff --git a/lib/librte_power/rte_power.h b/lib/librte_power/rte_power.h
index c8086bf6ba..ce672b01a9 100644
--- a/lib/librte_power/rte_power.h
+++ b/lib/librte_power/rte_power.h
@@ -171,14 +171,6 @@ typedef int (*rte_power_freq_change_t)(unsigned int lcore_id);
  * Scale up the frequency of a specific lcore according to the available
  * frequencies.
  * Review each environments specific documentation for usage.
- *
- * @param lcore_id
- *  lcore id.
- *
- * @return
- *  - 1 on success with frequency changed.
- *  - 0 on success without frequency changed.
- *  - Negative on error.
  */
 extern rte_power_freq_change_t rte_power_freq_up;
 
@@ -186,30 +178,13 @@ extern rte_power_freq_change_t rte_power_freq_up;
  * Scale down the frequency of a specific lcore according to the available
  * frequencies.
  * Review each environments specific documentation for usage.
- *
- * @param lcore_id
- *  lcore id.
- *
- * @return
- *  - 1 on success with frequency changed.
- *  - 0 on success without frequency changed.
- *  - Negative on error.
  */
-
 extern rte_power_freq_change_t rte_power_freq_down;
 
 /**
  * Scale up the frequency of a specific lcore to the highest according to the
  * available frequencies.
  * Review each environments specific documentation for usage.
- *
- * @param lcore_id
- *  lcore id.
- *
- * @return
- *  - 1 on success with frequency changed.
- *  - 0 on success without frequency changed.
- *  - Negative on error.
  */
 extern rte_power_freq_change_t rte_power_freq_max;
 
@@ -217,54 +192,24 @@ extern rte_power_freq_change_t rte_power_freq_max;
  * Scale down the frequency of a specific lcore to the lowest according to the
  * available frequencies.
  * Review each environments specific documentation for usage..
- *
- * @param lcore_id
- *  lcore id.
- *
- * @return
- *  - 1 on success with frequency changed.
- *  - 0 on success without frequency changed.
- *  - Negative on error.
  */
 extern rte_power_freq_change_t rte_power_freq_min;
 
 /**
  * Query the Turbo Boost status of a specific lcore.
  * Review each environments specific documentation for usage..
- *
- * @param lcore_id
- *  lcore id.
- *
- * @return
- *  - 1 Turbo Boost is enabled for this lcore.
- *  - 0 Turbo Boost is disabled for this lcore.
- *  - Negative on error.
  */
 extern rte_power_freq_change_t rte_power_turbo_status;
 
 /**
  * Enable Turbo Boost for this lcore.
  * Review each environments specific documentation for usage..
- *
- * @param lcore_id
- *  lcore id.
- *
- * @return
- *  - 0 on success.
- *  - Negative on error.
  */
 extern rte_power_freq_change_t rte_power_freq_enable_turbo;
 
 /**
  * Disable Turbo Boost for this lcore.
  * Review each environments specific documentation for usage..
- *
- * @param lcore_id
- *  lcore id.
- *
- * @return
- *  - 0 on success.
- *  - Negative on error.
  */
 extern rte_power_freq_change_t rte_power_freq_disable_turbo;
 
-- 
2.34.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2022-11-17 23:07:55.862129602 +0000
+++ 0008-power-fix-some-doxygen-comments.patch	2022-11-17 23:07:55.440329196 +0000
@@ -1 +1 @@
-From 58794bf8d2d577b18e8bd430fd6419274678b34e Mon Sep 17 00:00:00 2001
+From 76c23eded561afb5899cbbe8155e49bddf756204 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 58794bf8d2d577b18e8bd430fd6419274678b34e ]
+
@@ -13 +14,0 @@
-Cc: stable at dpdk.org
@@ -17 +18 @@
- lib/power/rte_power.h | 55 -------------------------------------------
+ lib/librte_power/rte_power.h | 55 ------------------------------------
@@ -20,5 +21,5 @@
-diff --git a/lib/power/rte_power.h b/lib/power/rte_power.h
-index 47345e26df..7954299489 100644
---- a/lib/power/rte_power.h
-+++ b/lib/power/rte_power.h
-@@ -169,14 +169,6 @@ typedef int (*rte_power_freq_change_t)(unsigned int lcore_id);
+diff --git a/lib/librte_power/rte_power.h b/lib/librte_power/rte_power.h
+index c8086bf6ba..ce672b01a9 100644
+--- a/lib/librte_power/rte_power.h
++++ b/lib/librte_power/rte_power.h
+@@ -171,14 +171,6 @@ typedef int (*rte_power_freq_change_t)(unsigned int lcore_id);
@@ -39 +40 @@
-@@ -184,30 +176,13 @@ extern rte_power_freq_change_t rte_power_freq_up;
+@@ -186,30 +178,13 @@ extern rte_power_freq_change_t rte_power_freq_up;
@@ -70 +71 @@
-@@ -215,54 +190,24 @@ extern rte_power_freq_change_t rte_power_freq_max;
+@@ -217,54 +192,24 @@ extern rte_power_freq_change_t rte_power_freq_max;