* [PATCH -next] PM/sleep: fix doc warnings in main.c
@ 2021-06-05 6:39 Baokun Li
2021-06-07 15:42 ` Rafael J. Wysocki
0 siblings, 1 reply; 2+ messages in thread
From: Baokun Li @ 2021-06-05 6:39 UTC (permalink / raw)
To: rjw, len.brown, pavel, linux-pm, linux-kernel
Cc: weiyongjun1, yuehaibing, yangjihong1, yukuai3, libaokun1
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.
* 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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH -next] PM/sleep: fix doc warnings in main.c
2021-06-05 6:39 [PATCH -next] PM/sleep: fix doc warnings in main.c Baokun Li
@ 2021-06-07 15:42 ` Rafael J. Wysocki
0 siblings, 0 replies; 2+ messages in thread
From: Rafael J. Wysocki @ 2021-06-07 15:42 UTC (permalink / raw)
To: Baokun Li
Cc: Rafael J. Wysocki, Len Brown, Pavel Machek, Linux PM,
Linux Kernel Mailing List, Wei Yongjun, Yue Haibing, yangjihong1,
yu kuai
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
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-06-07 15:42 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-06-05 6:39 [PATCH -next] PM/sleep: fix doc warnings in main.c Baokun Li
2021-06-07 15:42 ` Rafael J. Wysocki
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).