linux-kernel - Re: [PATCH -next v2] acpi/nvs: fix doc warnings in nvs.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]

Date:   Thu, 17 Jun 2021 14:37:55 +0200
From:   "Rafael J. Wysocki" <rafael@...nel.org>
To:     Baokun Li <libaokun1@...wei.com>
Cc:     "Rafael J. Wysocki" <rjw@...ysocki.net>,
        Len Brown <lenb@...nel.org>,
        ACPI Devel Maling List <linux-acpi@...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 v2] acpi/nvs: fix doc warnings in nvs.c

On Tue, Jun 15, 2021 at 9:34 AM Baokun Li <libaokun1@...wei.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@...wei.com>
> ---
> V1->V2:
>         Fix the formatting of this kerneldoc comment
>
>  drivers/acpi/nvs.c | 24 ++++++++++++------------
>  1 file changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/drivers/acpi/nvs.c b/drivers/acpi/nvs.c
> index 7f02e399047c..a2b11069e792 100644
> --- a/drivers/acpi/nvs.c
> +++ b/drivers/acpi/nvs.c
> @@ -84,13 +84,13 @@ struct nvs_page {
>  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
> + * suspend_nvs_register - register platform NVS memory region to save
> + * @start: Physical address of the region.
> + * @size: Size of the region.
>   *
> - *     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
> - *     be copied into separate RAM pages.
> + * 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
> + * be copied into separate RAM pages.
>   */
>  static int suspend_nvs_register(unsigned long start, unsigned long size)
>  {
> @@ -125,7 +125,7 @@ static int suspend_nvs_register(unsigned long start, unsigned long size)
>  }
>
>  /**
> - *     suspend_nvs_free - free data pages allocated for saving NVS regions
> + * suspend_nvs_free - free data pages allocated for saving NVS regions
>   */
>  void suspend_nvs_free(void)
>  {
> @@ -149,7 +149,7 @@ void suspend_nvs_free(void)
>  }
>
>  /**
> - *     suspend_nvs_alloc - allocate memory necessary for saving NVS regions
> + * suspend_nvs_alloc - allocate memory necessary for saving NVS regions
>   */
>  int suspend_nvs_alloc(void)
>  {
> @@ -166,7 +166,7 @@ int suspend_nvs_alloc(void)
>  }
>
>  /**
> - *     suspend_nvs_save - save NVS memory regions
> + * suspend_nvs_save - save NVS memory regions
>   */
>  int suspend_nvs_save(void)
>  {
> @@ -195,10 +195,10 @@ int suspend_nvs_save(void)
>  }
>
>  /**
> - *     suspend_nvs_restore - restore NVS memory regions
> + * suspend_nvs_restore - restore NVS memory regions
>   *
> - *     This function is going to be called with interrupts disabled, so it
> - *     cannot iounmap the virtual addresses used to access the NVS region.
> + * This function is going to be called with interrupts disabled, so it
> + * cannot iounmap the virtual addresses used to access the NVS region.
>   */
>  void suspend_nvs_restore(void)
>  {
> --

Applied as 5.14 material under a slightly edited subject, thanks!