[PATCH] PM: hibernate: don't mark comment as kernel-doc

Haowen Bai posted 1 patch 4 years, 2 months ago
kernel/power/snapshot.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] PM: hibernate: don't mark comment as kernel-doc
Posted by Haowen Bai 4 years, 2 months ago
Change the comment to a normal (non-kernel-doc) comment to avoid
these kernel-doc warnings:

kernel/power/snapshot.c:335: warning: This comment starts with '/**', but
 isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Data types related to memory bitmaps.

Signed-off-by: Haowen Bai <baihaowen@meizu.com>
---
 kernel/power/snapshot.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/power/snapshot.c b/kernel/power/snapshot.c
index 330d49937692..2a4d7d40161d 100644
--- a/kernel/power/snapshot.c
+++ b/kernel/power/snapshot.c
@@ -326,7 +326,7 @@ static void *chain_alloc(struct chain_allocator *ca, unsigned int size)
 	return ret;
 }
 
-/**
+/*
  * Data types related to memory bitmaps.
  *
  * Memory bitmap is a structure consisting of many linked lists of
-- 
2.7.4
Re: [PATCH] PM: hibernate: don't mark comment as kernel-doc
Posted by Rafael J. Wysocki 4 years, 2 months ago
On Fri, Apr 1, 2022 at 12:01 PM Haowen Bai <baihaowen@meizu.com> wrote:
>
> Change the comment to a normal (non-kernel-doc) comment to avoid
> these kernel-doc warnings:
>
> kernel/power/snapshot.c:335: warning: This comment starts with '/**', but
>  isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Data types related to memory bitmaps.
>
> Signed-off-by: Haowen Bai <baihaowen@meizu.com>
> ---
>  kernel/power/snapshot.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/kernel/power/snapshot.c b/kernel/power/snapshot.c
> index 330d49937692..2a4d7d40161d 100644
> --- a/kernel/power/snapshot.c
> +++ b/kernel/power/snapshot.c
> @@ -326,7 +326,7 @@ static void *chain_alloc(struct chain_allocator *ca, unsigned int size)
>         return ret;
>  }
>
> -/**
> +/*
>   * Data types related to memory bitmaps.
>   *
>   * Memory bitmap is a structure consisting of many linked lists of
> --

Applied as 5.19 material, thanks!