Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20210605063934.688763-1-libaokun1@huawei.com>
In-Reply-To: <20210605063934.688763-1-libaokun1@huawei.com>
From:   "Rafael J. Wysocki" <rafael@kernel.org>
Date:   Mon, 7 Jun 2021 17:42:14 +0200
Message-ID: <CAJZ5v0izpTc-cMWxQ0f0mSNQQZUz855ceKFUC0_Z6kd1eNMaEw@mail.gmail.com>
Subject: Re: [PATCH -next] PM/sleep: fix doc warnings in main.c
To:     Baokun Li <libaokun1@huawei.com>
Cc:     "Rafael J. Wysocki" <rjw@rjwysocki.net>,
        Len Brown <len.brown@intel.com>, Pavel Machek <pavel@ucw.cz>,
        Linux PM <linux-pm@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Wei Yongjun <weiyongjun1@huawei.com>,
        Yue Haibing <yuehaibing@huawei.com>, yangjihong1@huawei.com,
        yu kuai <yukuai3@huawei.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

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
>