2024-01-14 03:06:29

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] cpu/hotplug: delete an extraneous kernel-doc description

struct cpuhp_cpu_state has an extraneous kernel-doc comment for @cpu.
There is no struct member by that name, so remove the comment to
prevent the kernel-doc warning:

kernel/cpu.c:85: warning: Excess struct member 'cpu' description in 'cpuhp_cpu_state'

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Cc: Peter Zijlstra <[email protected]>
---
kernel/cpu.c | 1 -
1 file changed, 1 deletion(-)

diff -- a/kernel/cpu.c b/kernel/cpu.c
--- a/kernel/cpu.c
+++ b/kernel/cpu.c
@@ -54,7 +54,6 @@
* @rollback: Perform a rollback
* @single: Single callback invocation
* @bringup: Single callback bringup or teardown selector
- * @cpu: CPU number
* @node: Remote CPU node; for multi-instance, do a
* single entry callback for install/remove
* @last: For multi-instance rollback, remember how far we got


Subject: [tip: smp/core] cpu/hotplug: Delete an extraneous kernel-doc description

The following commit has been merged into the smp/core branch of tip:

Commit-ID: ef7e585bf48013baabc00de1a15753dd7b626a2d
Gitweb: https://git.kernel.org/tip/ef7e585bf48013baabc00de1a15753dd7b626a2d
Author: Randy Dunlap <[email protected]>
AuthorDate: Sat, 13 Jan 2024 19:06:15 -08:00
Committer: Thomas Gleixner <[email protected]>
CommitterDate: Fri, 26 Jan 2024 17:44:42 +01:00

cpu/hotplug: Delete an extraneous kernel-doc description

struct cpuhp_cpu_state has an extraneous kernel-doc comment for @cpu.
There is no struct member by that name, so remove the comment to
prevent the kernel-doc warning:

kernel/cpu.c:85: warning: Excess struct member 'cpu' description in 'cpuhp_cpu_state'

Signed-off-by: Randy Dunlap <[email protected]>
Signed-off-by: Thomas Gleixner <[email protected]>
Link: https://lore.kernel.org/r/[email protected]

---
kernel/cpu.c | 1 -
1 file changed, 1 deletion(-)

diff --git a/kernel/cpu.c b/kernel/cpu.c
index e6ec3ba..f059375 100644
--- a/kernel/cpu.c
+++ b/kernel/cpu.c
@@ -54,7 +54,6 @@
* @rollback: Perform a rollback
* @single: Single callback invocation
* @bringup: Single callback bringup or teardown selector
- * @cpu: CPU number
* @node: Remote CPU node; for multi-instance, do a
* single entry callback for install/remove
* @last: For multi-instance rollback, remember how far we got