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

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Wed, 13 Apr 2022 17:10:36 +0200
From:   "Rafael J. Wysocki" <rafael@...nel.org>
To:     Haowen Bai <baihaowen@...zu.com>
Cc:     "Rafael J. Wysocki" <rafael@...nel.org>,
        Pavel Machek <pavel@....cz>, Len Brown <len.brown@...el.com>,
        Linux PM <linux-pm@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] PM: hibernate: don't mark comment as kernel-doc

On Fri, Apr 1, 2022 at 12:01 PM Haowen Bai <baihaowen@...zu.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@...zu.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!