linux-kernel - Re: [PATCH] block: Fix non-kernel-doc comment

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <918fe170-51ef-e214-4620-3a82b425965c@infradead.org>
Date:   Mon, 14 Feb 2022 09:14:38 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Jiapeng Chong <jiapeng.chong@...ux.alibaba.com>, rafael@...nel.org
Cc:     pavel@....cz, len.brown@...el.com, linux-pm@...r.kernel.org,
        linux-kernel@...r.kernel.org, Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH] block: Fix non-kernel-doc comment

Hi--

On 2/14/22 01:15, Jiapeng Chong wrote:
> Fixes the following W=1 kernel build warning:
> 
> kernel/power/swap.c:120: warning: This comment starts with '/**', but
> isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst.
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Jiapeng Chong <jiapeng.chong@...ux.alibaba.com>

The diff looks OK to me, but the Subject is quite misleading.
There are no "block:" patch contents here, just "PM:" or
"PM: hibernate:" according to
$ git log --oneline kernel/power/swap.c

> ---
>  kernel/power/swap.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/kernel/power/swap.c b/kernel/power/swap.c
> index 6c4f983cbacc..91fffdd2c7fb 100644
> --- a/kernel/power/swap.c
> +++ b/kernel/power/swap.c
> @@ -88,7 +88,7 @@ struct swap_map_page_list {
>  	struct swap_map_page_list *next;
>  };
>  
> -/**
> +/*
>   *	The swap_map_handle structure is used for handling swap in
>   *	a file-alike way
>   */
> @@ -116,7 +116,7 @@ struct swsusp_header {
>  
>  static struct swsusp_header *swsusp_header;
>  
> -/**
> +/*
>   *	The following functions are used for tracing the allocated
>   *	swap pages, so that they can be freed in case of an error.
>   */
> @@ -170,7 +170,7 @@ static int swsusp_extents_insert(unsigned long swap_offset)
>  	return 0;
>  }
>  
> -/**
> +/*
>   *	alloc_swapdev_block - allocate a swap page and register that it has
>   *	been allocated, so that it can be freed in case of an error.
>   */
> @@ -189,7 +189,7 @@ sector_t alloc_swapdev_block(int swap)
>  	return 0;
>  }
>  
> -/**
> +/*
>   *	free_all_swap_pages - free swap pages allocated for saving image data.
>   *	It also frees the extents used to register which swap entries had been
>   *	allocated.

thanks.
-- 
~Randy