diff mbox series

[v2] PM: domains: fix inappropriate use of kernel-doc

Message ID 20231107005412.24070-1-rdunlap@infradead.org
State New
Headers
Series [v2] PM: domains: fix inappropriate use of kernel-doc |

Commit Message

Randy Dunlap Nov. 7, 2023, 12:54 a.m. UTC 
  There is no mechanism for using kernel-doc notation on a data item
(only struct/union/enum definitions, functions, and function-like
macros). Since the comment does not add any useful information,
just drop it completely to avoid a kernel-doc warning:

drivers/base/power/domain_governor.c:412: warning: cannot understand function prototype: 'struct dev_power_governor pm_domain_always_on_gov = '

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Kevin Hilman <khilman@kernel.org>
Cc: Ulf Hansson <ulf.hansson@linaro.org>
Cc: linux-pm@vger.kernel.org
---
v2: drop the comment completely (Ulf)

 drivers/base/power/domain_governor.c |    3 ---
 1 file changed, 3 deletions(-)
diff mbox series

Patch

diff -- a/drivers/base/power/domain_governor.c b/drivers/base/power/domain_governor.c
--- a/drivers/base/power/domain_governor.c
+++ b/drivers/base/power/domain_governor.c
@@ -406,9 +406,6 @@  struct dev_power_governor simple_qos_gov
 	.power_down_ok = default_power_down_ok,
 };
 
-/**
- * pm_genpd_gov_always_on - A governor implementing an always-on policy
- */
 struct dev_power_governor pm_domain_always_on_gov = {
 	.suspend_ok = default_suspend_ok,
 };