2024-05-06 00:42:30

by Jeff Johnson

Subject: [PATCH] cpuidle: ladder: fix ladder_do_selection() kernel-doc

make C=1 reports:

warning: Function parameter or struct member 'dev' not described in 'ladder_do_selection'

Document 'dev' for this function.

Signed-off-by: Jeff Johnson <[email protected]>
---
drivers/cpuidle/governors/ladder.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/cpuidle/governors/ladder.c b/drivers/cpuidle/governors/ladder.c
index 8e9058c4ea63..6617eb494a11 100644
--- a/drivers/cpuidle/governors/ladder.c
+++ b/drivers/cpuidle/governors/ladder.c
@@ -44,6 +44,7 @@ static DEFINE_PER_CPU(struct ladder_device, ladder_devices);

/**
* ladder_do_selection - prepares private data for a state change
+ * @dev: the CPU
* @ldev: the ladder device
* @old_idx: the current state index
* @new_idx: the new target state index

---
base-commit: dd5a440a31fae6e459c0d6271dddd62825505361
change-id: 20240505-ladder_do_selection-kdoc-97d13884b847

2024-05-07 11:56:49

by Rafael J. Wysocki

Subject: Re: [PATCH] cpuidle: ladder: fix ladder_do_selection() kernel-doc

On Mon, May 6, 2024 at 2:42 AM Jeff Johnson <[email protected]> wrote:
>
> make C=1 reports:
>
> warning: Function parameter or struct member 'dev' not described in 'ladder_do_selection'
>
> Document 'dev' for this function.
>
> Signed-off-by: Jeff Johnson <[email protected]>
> ---
> drivers/cpuidle/governors/ladder.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/cpuidle/governors/ladder.c b/drivers/cpuidle/governors/ladder.c
> index 8e9058c4ea63..6617eb494a11 100644
> --- a/drivers/cpuidle/governors/ladder.c
> +++ b/drivers/cpuidle/governors/ladder.c
> @@ -44,6 +44,7 @@ static DEFINE_PER_CPU(struct ladder_device, ladder_devices);
>
> /**
> * ladder_do_selection - prepares private data for a state change
> + * @dev: the CPU
> * @ldev: the ladder device
> * @old_idx: the current state index
> * @new_idx: the new target state index
>
> ---

Applied as 6.10 material, thanks!