MIME-Version: 1.0
References: <20211210042849.79924-1-yang.lee@linux.alibaba.com>
In-Reply-To: <20211210042849.79924-1-yang.lee@linux.alibaba.com>
From:   "Rafael J. Wysocki" <rafael@kernel.org>
Date:   Fri, 17 Dec 2021 16:24:09 +0100
Message-ID: <CAJZ5v0hM41gPb2epxtSRN=cseBrtf1DLtp8eExdJoa_ZwXXoww@mail.gmail.com>
Subject: Re: [PATCH -next 1/2] cpuidle: Fix kernel-doc
To:     Yang Li <yang.lee@linux.alibaba.com>
Cc:     "Rafael J. Wysocki" <rafael@kernel.org>,
        Andy Gross <agross@kernel.org>,
        Bjorn Andersson <bjorn.andersson@linaro.org>,
        Daniel Lezcano <daniel.lezcano@linaro.org>,
        linux-arm-msm <linux-arm-msm@vger.kernel.org>,
        Linux PM <linux-pm@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Abaci Robot <abaci@linux.alibaba.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Fri, Dec 10, 2021 at 5:29 AM Yang Li <yang.lee@linux.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@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.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!