linux-kernel - Re: [PATCH -next] PM/sleep: fix doc warnings in main.c

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAJZ5v0izpTc-cMWxQ0f0mSNQQZUz855ceKFUC0_Z6kd1eNMaEw@mail.gmail.com>
Date:   Mon, 7 Jun 2021 17:42:14 +0200
From:   "Rafael J. Wysocki" <rafael@...nel.org>
To:     Baokun Li <libaokun1@...wei.com>
Cc:     "Rafael J. Wysocki" <rjw@...ysocki.net>,
        Len Brown <len.brown@...el.com>, Pavel Machek <pavel@....cz>,
        Linux PM <linux-pm@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Wei Yongjun <weiyongjun1@...wei.com>,
        Yue Haibing <yuehaibing@...wei.com>, yangjihong1@...wei.com,
        yu kuai <yukuai3@...wei.com>
Subject: Re: [PATCH -next] PM/sleep: fix doc warnings in main.c

On Sat, Jun 5, 2021 at 8:30 AM Baokun Li <libaokun1@...wei.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@...wei.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
>