Re: [PATCH -next] sched: fix cid_lock kernel-doc warnings

[Mathieu Desnoyers]

On 2023-04-27 23:11, Randy Dunlap wrote:
> Fix kernel-doc warnings for cid_lock and use_cid_lock.
> These comments are not in kernel-doc format.
>
> kernel/sched/core.c:11496: warning: Cannot understand  * @cid_lock: Guarantee forward-progress of cid allocation.
>   on line 11496 - I thought it was a doc line
> kernel/sched/core.c:11505: warning: Cannot understand  * @use_cid_lock: Select cid allocation behavior: lock-free vs spinlock.
>   on line 11505 - I thought it was a doc line

Right. It made sense to have those as kernel-doc when those were 
mm_struct fields in previous versions of the patch, but not anymore now 
that those are stand-alone static variables.

Acked-by: Mathieu Desnoyers <mathieu.desnoyers@xxxxxxxxxxxx>

Thanks,

Mathieu

> Fixes: 223baf9d17f2 ("sched: Fix performance regression introduced by mm_cid")
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Mathieu Desnoyers <mathieu.desnoyers@xxxxxxxxxxxx>
> Cc: "Peter Zijlstra (Intel)" <peterz@xxxxxxxxxxxxx>
> Cc: Ingo Molnar <mingo@xxxxxxxxxx>
> ---
>   kernel/sched/core.c |    4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff -- a/kernel/sched/core.c b/kernel/sched/core.c
> --- a/kernel/sched/core.c
> +++ b/kernel/sched/core.c
> @@ -11492,7 +11492,7 @@ void call_trace_sched_update_nr_running(
>   
>   #ifdef CONFIG_SCHED_MM_CID
>   
> -/**
> +/*
>    * @cid_lock: Guarantee forward-progress of cid allocation.
>    *
>    * Concurrency ID allocation within a bitmap is mostly lock-free. The cid_lock
> @@ -11501,7 +11501,7 @@ void call_trace_sched_update_nr_running(
>    */
>   DEFINE_RAW_SPINLOCK(cid_lock);
>   
> -/**
> +/*
>    * @use_cid_lock: Select cid allocation behavior: lock-free vs spinlock.
>    *
>    * When @use_cid_lock is 0, the cid allocation is lock-free. When contention is

--
Mathieu Desnoyers
EfficiOS Inc.
https://www.efficios.com