2022-02-15 06:04:03

by Jiapeng Chong

[permalink] [raw]
Subject: [PATCH v2] PM: hibernate: Fix non-kernel-doc comment

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 <[email protected]>
Signed-off-by: Jiapeng Chong <[email protected]>
---
Changes in v2:
-Modify subject 'block' to 'PM: hibernate'.

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


2022-03-01 16:18:06

by Rafael J. Wysocki

[permalink] [raw]
Subject: Re: [PATCH v2] PM: hibernate: Fix non-kernel-doc comment

On Tue, Feb 15, 2022 at 4:38 AM Jiapeng Chong
<[email protected]> 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 <[email protected]>
> Signed-off-by: Jiapeng Chong <[email protected]>
> ---
> Changes in v2:
> -Modify subject 'block' to 'PM: hibernate'.
>
> 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.
> --

Applied as 5.18 material with adjustments in the subject and changelog.

Thanks!