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

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

[Jiapeng Chong]

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@linux.alibaba.com>
Signed-off-by: Jiapeng Chong <jiapeng.chong@linux.alibaba.com>
---
 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.
-- 
2.20.1.7.g153144c

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

[Randy Dunlap]

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@linux.alibaba.com>
> Signed-off-by: Jiapeng Chong <jiapeng.chong@linux.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

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

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 679 bytes --]

Hi!

> 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.
> +++ b/kernel/power/swap.c

> @@ -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.
>   */

The ones before look ok, but this and next one perhaps should be
converted to kerneldoc?

BR,
							Pavel
-- 
http://www.livejournal.com/~pavelmachek

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]