Re: [PATCH] kernel/power: unmark 'state' functions as kernel-doc

From: Rafael J. Wysocki
Date: Mon Aug 16 2021 - 12:51:05 EST


On Tue, Aug 10, 2021 at 3:44 AM Randy Dunlap <rdunlap@xxxxxxxxxxxxx> 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@xxxxxxxxxxxxx>
> Cc: "Rafael J. Wysocki" <rjw@xxxxxxxxxxxxx>
> Cc: Pavel Machek <pavel@xxxxxx>
> Cc: Len Brown <len.brown@xxxxxxxxx>
> Cc: linux-pm@xxxxxxxxxxxxxxx
> ---
> 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!