linux-kernel - Re: [PATCH] PM: domains: fix inappropriate use of 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: <CAPDyKFp+rXEnCZq30w1BiQRn09usYQ49qTqeouxEN3BHmV7CRA@mail.gmail.com>
Date:   Mon, 6 Nov 2023 15:48:35 +0100
From:   Ulf Hansson <ulf.hansson@...aro.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org,
        "Rafael J. Wysocki" <rafael@...nel.org>,
        Kevin Hilman <khilman@...nel.org>, linux-pm@...r.kernel.org
Subject: Re: [PATCH] PM: domains: fix inappropriate use of kernel-doc

On Sat, 4 Nov 2023 at 04:40, Randy Dunlap <rdunlap@...radead.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@...radead.org>
> Cc: "Rafael J. Wysocki" <rafael@...nel.org>
> Cc: Kevin Hilman <khilman@...nel.org>
> Cc: Ulf Hansson <ulf.hansson@...aro.org>
> Cc: linux-pm@...r.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