Skip to contentSkip to conversation

PM/sleep: fix doc warnings in main.c

PATCH In review Baokun Li 2 participants 2 messages Jun 5, 2021 – Jun 7, 2021

Subsystems (2)
lore
Share & tools
lore

Baokun Li

author
#0 lore raw

PATCH 1/1 PM/sleep: fix doc warnings in main.c

Add description for state_show to fix the W=1 warnings:

kernel/power/main.c:593: warning:
Function parameter or member 'kobj' not described in 'state_show'
kernel/power/main.c:593: warning:
Function parameter or member 'attr' not described in 'state_show'
kernel/power/main.c:593: warning:
Function parameter or member 'buf' not described in 'state_show'

---
 kernel/power/main.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
kernel/power/main.c +3 -1
index 12c7e1bb442f..d508c8c582e0 100644
@@ -579,7 +579,9 @@ struct kobject *power_kobj;
 
 /**
  * state - control system sleep states.
- *
+ * @kobj: Pointer to the kernel object.
+ * @attr: Pointer to the kernel object attribute.
+ * @buf: buffer.
  * show() returns available sleep state labels, which may be "mem", "standby",
  * "freeze" and "disk" (hibernation).
  * See Documentation/admin-guide/pm/sleep-states.rst for a description of
Signature · 1 line
2.31.1
#1 lore raw
Quoted 20 lines · Baokun Li

Add description for state_show to fix the W=1 warnings:

kernel/power/main.c:593: warning:
Function parameter or member 'kobj' not described in 'state_show'
kernel/power/main.c:593: warning:
Function parameter or member 'attr' not described in 'state_show'
kernel/power/main.c:593: warning:
Function parameter or member 'buf' not described in 'state_show'

---
 kernel/power/main.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
kernel/power/main.c +0 -0
index 12c7e1bb442f..d508c8c582e0 100644

kernel/power/main.c struct kobject *power_kobj; · line 584

Quoted 7 lines
kernel/power/main.c +3 -1
@@ -579,7 +579,9 @@ struct kobject *power_kobj;
 
 /**
  * state - control system sleep states.
- *
+ * @kobj: Pointer to the kernel object.
+ * @attr: Pointer to the kernel object attribute.
+ * @buf: buffer.

Please fix this properly or don't touch it.

This is not a kerneldoc comment of a function and so adding argument descriptions to it is pointless.

Quoted 6 lines
kernel/power/main.c +0 -1
  * show() returns available sleep state labels, which may be "mem", "standby",
  * "freeze" and "disk" (hibernation).
  * See Documentation/admin-guide/pm/sleep-states.rst for a description of
--

2.31.1