diff mbox series

cpuidle: ladder: fix ladder_do_selection() kernel-doc

Message ID 20240505-ladder_do_selection-kdoc-v1-1-fa0da92735dd@quicinc.com
State Accepted
Commit 774459238f80f914bb133099239f3a150892d342
Headers show
Series cpuidle: ladder: fix ladder_do_selection() kernel-doc | expand

Commit Message

Jeff Johnson May 6, 2024, 12:42 a.m. UTC
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 <quic_jjohnson@quicinc.com>
---
 drivers/cpuidle/governors/ladder.c | 1 +
 1 file changed, 1 insertion(+)


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

Comments

Rafael J. Wysocki May 7, 2024, 11:56 a.m. UTC | #1
On Mon, May 6, 2024 at 2:42 AM Jeff Johnson <quic_jjohnson@quicinc.com> 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 <quic_jjohnson@quicinc.com>
> ---
>  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!
diff mbox series

Patch

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