[-next] PM/sleep: fix doc warnings in main.c

Message ID 20210605063934.688763-1-libaokun1@huawei.com
State New
Headers show
Series
  • [-next] PM/sleep: fix doc warnings in main.c
Related show

Commit Message

Baokun Li June 5, 2021, 6:39 a.m.
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'

Signed-off-by: Baokun Li <libaokun1@huawei.com>
---
 kernel/power/main.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Rafael J. Wysocki June 7, 2021, 3:42 p.m. | #1
On Sat, Jun 5, 2021 at 8:30 AM Baokun Li <libaokun1@huawei.com> wrote:
>

> 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'

>

> Signed-off-by: Baokun Li <libaokun1@huawei.com>

> ---

>  kernel/power/main.c | 4 +++-

>  1 file changed, 3 insertions(+), 1 deletion(-)

>

> diff --git a/kernel/power/main.c b/kernel/power/main.c

> index 12c7e1bb442f..d508c8c582e0 100644

> --- a/kernel/power/main.c

> +++ b/kernel/power/main.c

> @@ -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.

>   * 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

>

Patch

diff --git a/kernel/power/main.c b/kernel/power/main.c
index 12c7e1bb442f..d508c8c582e0 100644
--- a/kernel/power/main.c
+++ b/kernel/power/main.c
@@ -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