linux-kernel - Re: [PATCH -next 1/2] cpuidle: Fix 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: <CAJZ5v0hM41gPb2epxtSRN=cseBrtf1DLtp8eExdJoa_ZwXXoww@mail.gmail.com>
Date:   Fri, 17 Dec 2021 16:24:09 +0100
From:   "Rafael J. Wysocki" <rafael@...nel.org>
To:     Yang Li <yang.lee@...ux.alibaba.com>
Cc:     "Rafael J. Wysocki" <rafael@...nel.org>,
        Andy Gross <agross@...nel.org>,
        Bjorn Andersson <bjorn.andersson@...aro.org>,
        Daniel Lezcano <daniel.lezcano@...aro.org>,
        linux-arm-msm <linux-arm-msm@...r.kernel.org>,
        Linux PM <linux-pm@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next 1/2] cpuidle: Fix kernel-doc

On Fri, Dec 10, 2021 at 5:29 AM Yang Li <yang.lee@...ux.alibaba.com> wrote:
>
> Fix function name in sysfs.c kernel-doc comment
> to remove a warning found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
>
> drivers/cpuidle/sysfs.c:512: warning: expecting prototype for
> cpuidle_remove_driver_sysfs(). Prototype was for
> cpuidle_remove_state_sysfs() instead
>
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
> ---
>  drivers/cpuidle/sysfs.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/cpuidle/sysfs.c b/drivers/cpuidle/sysfs.c
> index 469e18547d06..e708e593db88 100644
> --- a/drivers/cpuidle/sysfs.c
> +++ b/drivers/cpuidle/sysfs.c
> @@ -505,7 +505,7 @@ static int cpuidle_add_state_sysfs(struct cpuidle_device *device)
>  }
>
>  /**
> - * cpuidle_remove_driver_sysfs - removes the cpuidle states sysfs attributes
> + * cpuidle_remove_state_sysfs - removes the cpuidle states sysfs attributes
>   * @device: the target device
>   */
>  static void cpuidle_remove_state_sysfs(struct cpuidle_device *device)
> --

Applied as 5.17 under a more precise subject ("cpuidle: Fix
cpuidle_remove_state_sysfs() kerneldoc comment").

When you submit changes like this in the future, please always make
the subject precise enough to allow the given change to be easily
distinguished from other changes in the same category.

Thanks!