lkml.org 
[lkml]   [2023]   [Nov]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [PATCH] PM: domains: fix inappropriate use of kernel-doc
On Sat, 4 Nov 2023 at 04:40, Randy Dunlap <rdunlap@infradead.org> wrote:
>
> There is no mechanism for using kernel-doc notation on a data item
> (only struct/union/enum definitions, functions, and function-like
> macros), so convert the "/**" notation to C comment "/*" notation
> to avoid a kernel-doc warning:
>
> drivers/base/power/domain_governor.c:412: warning: cannot understand function prototype: 'struct dev_power_governor pm_domain_always_on_gov = '
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: "Rafael J. Wysocki" <rafael@kernel.org>
> Cc: Kevin Hilman <khilman@kernel.org>
> Cc: Ulf Hansson <ulf.hansson@linaro.org>
> Cc: linux-pm@vger.kernel.org
> ---
> drivers/base/power/domain_governor.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/base/power/domain_governor.c b/drivers/base/power/domain_governor.c
> --- a/drivers/base/power/domain_governor.c
> +++ b/drivers/base/power/domain_governor.c
> @@ -406,7 +406,7 @@ struct dev_power_governor simple_qos_gov
> .power_down_ok = default_power_down_ok,
> };
>
> -/**
> +/*
> * pm_genpd_gov_always_on - A governor implementing an always-on policy
> */

While at it, may I suggest that we instead just drop the function
description altogether. It's not really adding something useful that
is not already understandable by looking at the code below, I think.

> struct dev_power_governor pm_domain_always_on_gov = {

Kind regards
Uffe

\
 
 \ /
  Last update: 2023-11-20 13:50    [W:0.039 / U:0.088 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site