linux-kernel - Re: [PATCH] kernel/power: unmark 'state' functions 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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <CAJZ5v0gVpmf3_73f0X6yEWA+vkP2LGjdmU+c6AtofAm_tiEXqg@mail.gmail.com>
Date:   Mon, 16 Aug 2021 18:50:50 +0200
From:   "Rafael J. Wysocki" <rafael@...nel.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        "Rafael J. Wysocki" <rjw@...ysocki.net>,
        Pavel Machek <pavel@....cz>, Len Brown <len.brown@...el.com>,
        Linux PM <linux-pm@...r.kernel.org>
Subject: Re: [PATCH] kernel/power: unmark 'state' functions as kernel-doc

On Tue, Aug 10, 2021 at 3:44 AM Randy Dunlap <rdunlap@...radead.org> wrote:
>
> Fix kernel-doc warnings in kernel/power/main.c by unmarking the
> comment block as kernel-doc notation. This eliminates the following
> kernel-doc warnings:
>
> kernel/power/main.c:593: warning: expecting prototype for state(). Prototype was for state_show() instead
> kernel/power/main.c:593: warning: Function parameter or member 'kobj' not described in 'state_show'
> kernel/power/main.c:593: warning: Function parameter or member 'attr' not described in 'state_show'
> kernel/power/main.c:593: warning: Function parameter or member 'buf' not described in 'state_show'
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: "Rafael J. Wysocki" <rjw@...ysocki.net>
> Cc: Pavel Machek <pavel@....cz>
> Cc: Len Brown <len.brown@...el.com>
> Cc: linux-pm@...r.kernel.org
> ---
>  kernel/power/main.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-next-20210809.orig/kernel/power/main.c
> +++ linux-next-20210809/kernel/power/main.c
> @@ -577,7 +577,7 @@ static inline void pm_print_times_init(v
>
>  struct kobject *power_kobj;
>
> -/**
> +/*
>   * state - control system sleep states.
>   *
>   * show() returns available sleep state labels, which may be "mem", "standby",

Applied as 5.15 material, thanks!