2021-12-10 04:29:13

by Yang Li

Subject: [PATCH -next 1/2] cpuidle: Fix kernel-doc

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 <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
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)
--
2.20.1.7.g153144c

2021-12-17 15:24:24

by Rafael J. Wysocki

Subject: Re: [PATCH -next 1/2] cpuidle: Fix kernel-doc

On Fri, Dec 10, 2021 at 5:29 AM Yang Li <[email protected]> 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 <[email protected]>
> Signed-off-by: Yang Li <[email protected]>
> ---
> 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!