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: <20210608023841.2746826-1-libaokun1@huawei.com>
In-Reply-To: <20210608023841.2746826-1-libaokun1@huawei.com>
From:   "Rafael J. Wysocki" <rafael@kernel.org>
Date:   Wed, 9 Jun 2021 15:12:14 +0200
Message-ID: <CAJZ5v0iPcSwjswJ7+1gPk-CKowLST7LG-4RQx_LkwFV+fUW6Gg@mail.gmail.com>
Subject: Re: [PATCH -next] acpi/nvs: fix doc warnings in nvs.c
To:     Baokun Li <libaokun1@huawei.com>
Cc:     "Rafael J. Wysocki" <rjw@rjwysocki.net>,
        Len Brown <lenb@kernel.org>,
        ACPI Devel Maling List <linux-acpi@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 Tue, Jun 8, 2021 at 4:29 AM Baokun Li <libaokun1@huawei.com> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/acpi/nvs.c:94: warning: Function parameter or
>   member 'start' not described in 'suspend_nvs_register'
>  drivers/acpi/nvs.c:94: warning: Function parameter or
>   member 'size' not described in 'suspend_nvs_register'
>
> Signed-off-by: Baokun Li <libaokun1@huawei.com>
> ---
>  drivers/acpi/nvs.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/acpi/nvs.c b/drivers/acpi/nvs.c
> index 9f8712a557b3..4609a8a2e42d 100644
> --- a/drivers/acpi/nvs.c
> +++ b/drivers/acpi/nvs.c
> @@ -83,8 +83,8 @@ static LIST_HEAD(nvs_list);
>
>  /**
>   *     suspend_nvs_register - register platform NVS memory region to save
> - *     @start - physical address of the region
> - *     @size - size of the region
> + *     @start: physical address of the region
> + *     @size: size of the region

The format of this kerneldoc comment is still not following the common
style after your change.

Please fix it completely.

>   *
>   *     The NVS region need not be page-aligned (both ends) and we arrange
>   *     things so that the data from page-aligned addresses in this region will
> --
> 2.31.1
>