[PATCH] sched_ext: repair kernel-doc comments

[PATCH] sched_ext: repair kernel-doc comments

[Randy Dunlap]

Add missing function parameter descriptions and use the correct
function name in kernel-doc comments to avoid kernel-doc warnings:

Warning: kernel/sched/ext/ext.c:2692 function parameter 'sch' not described in 'finish_dispatch'
Warning: kernel/sched/ext/ext.c:5309 function parameter 'stalled_mask' not described in 'scx_rcu_cpu_stall'
Warning: kernel/sched/ext/ext.c:5405 function parameter 'cpu' not described in 'scx_hardlockup'
Warning: kernel/sched/ext/ext.c:8470 expecting prototype for scx_bpf_dsq_insert(). Prototype was for scx_bpf_dsq_insert___v2() instead
Warning: kernel/sched/ext/ext.c:8784 expecting prototype for scx_bpf_dsq_move_to_local(). Prototype was for scx_bpf_dsq_move_to_local___v2() instead
Warning: kernel/sched/ext/ext.c:9498 expecting prototype for scx_bpf_reenqueue_local(). Prototype was for scx_bpf_reenqueue_local___v2() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Tejun Heo <tj@kernel.org>
Cc: David Vernet <void@manifault.com>
Cc: Andrea Righi <arighi@nvidia.com>
Cc: Changwoo Min <changwoo@igalia.com>
Cc: sched-ext@lists.linux.dev

 kernel/sched/ext/ext.c |    9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

--- linux-next-20260722.orig/kernel/sched/ext/ext.c
+++ linux-next-20260722/kernel/sched/ext/ext.c
@@ -2669,6 +2669,7 @@ static void dispatch_to_local_dsq(struct
 
 /**
  * finish_dispatch - Asynchronously finish dispatching a task
+ * @sch: the scheduler
  * @rq: current rq which is locked
  * @p: task to finish dispatching
  * @qseq_at_dispatch: qseq when @p started getting dispatched
@@ -5296,6 +5297,7 @@ static __printf(2, 3) bool handle_lockup
 
 /**
  * scx_rcu_cpu_stall - sched_ext RCU CPU stall handler
+ * @stalled_mask: bit mask of stalled CPUs
  *
  * While there are various reasons why RCU CPU stalls can occur on a system
  * that may not be caused by the current BPF scheduler, try kicking out the
@@ -5390,6 +5392,7 @@ static DEFINE_IRQ_WORK(scx_hardlockup_ir
 
 /**
  * scx_hardlockup - sched_ext hardlockup handler
+ * @cpu: the target CPU
  *
  * A poorly behaving BPF scheduler can trigger hard lockup by e.g. putting
  * numerous affinitized tasks in a single queue and directing all CPUs at it.
@@ -8426,7 +8429,7 @@ static void scx_dsq_insert_commit(struct
 __bpf_kfunc_start_defs();
 
 /**
- * scx_bpf_dsq_insert - Insert a task into the FIFO queue of a DSQ
+ * scx_bpf_dsq_insert___v2 - Insert a task into the FIFO queue of a DSQ
  * @p: task_struct to insert
  * @dsq_id: DSQ to insert into
  * @slice: duration @p can run for in nsecs, 0 to keep the current value
@@ -8756,7 +8759,7 @@ __bpf_kfunc void scx_bpf_dispatch_cancel
 }
 
 /**
- * scx_bpf_dsq_move_to_local - move a task from a DSQ to the current CPU's local DSQ
+ * scx_bpf_dsq_move_to_local___v2 - move a task from a DSQ to the current CPU's local DSQ
  * @dsq_id: DSQ to move task from. Must be a user-created DSQ
  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
  * @enq_flags: %SCX_ENQ_*
@@ -9485,7 +9488,7 @@ __bpf_kfunc void scx_bpf_dsq_reenq(u64 d
 }
 
 /**
- * scx_bpf_reenqueue_local - Re-enqueue tasks on a local DSQ
+ * scx_bpf_reenqueue_local___v2 - Re-enqueue tasks on a local DSQ
  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
  *
  * Iterate over all of the tasks currently enqueued on the local DSQ of the

Re: [PATCH] sched_ext: repair kernel-doc comments

[Andrea Righi]

Hi Randy,

On Thu, Jul 23, 2026 at 10:31:18AM -0700, Randy Dunlap wrote:
> Add missing function parameter descriptions and use the correct
> function name in kernel-doc comments to avoid kernel-doc warnings:
> 
> Warning: kernel/sched/ext/ext.c:2692 function parameter 'sch' not described in 'finish_dispatch'
> Warning: kernel/sched/ext/ext.c:5309 function parameter 'stalled_mask' not described in 'scx_rcu_cpu_stall'
> Warning: kernel/sched/ext/ext.c:5405 function parameter 'cpu' not described in 'scx_hardlockup'
> Warning: kernel/sched/ext/ext.c:8470 expecting prototype for scx_bpf_dsq_insert(). Prototype was for scx_bpf_dsq_insert___v2() instead
> Warning: kernel/sched/ext/ext.c:8784 expecting prototype for scx_bpf_dsq_move_to_local(). Prototype was for scx_bpf_dsq_move_to_local___v2() instead
> Warning: kernel/sched/ext/ext.c:9498 expecting prototype for scx_bpf_reenqueue_local(). Prototype was for scx_bpf_reenqueue_local___v2() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Looks good to me, thanks for the cleanup!

Reviewed-by: Andrea Righi <arighi@nvidia.com>

-Andrea

> ---
> Cc: Ingo Molnar <mingo@redhat.com>
> Cc: Peter Zijlstra <peterz@infradead.org>
> Cc: Tejun Heo <tj@kernel.org>
> Cc: David Vernet <void@manifault.com>
> Cc: Andrea Righi <arighi@nvidia.com>
> Cc: Changwoo Min <changwoo@igalia.com>
> Cc: sched-ext@lists.linux.dev
> 
>  kernel/sched/ext/ext.c |    9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> --- linux-next-20260722.orig/kernel/sched/ext/ext.c
> +++ linux-next-20260722/kernel/sched/ext/ext.c
> @@ -2669,6 +2669,7 @@ static void dispatch_to_local_dsq(struct
>  
>  /**
>   * finish_dispatch - Asynchronously finish dispatching a task
> + * @sch: the scheduler
>   * @rq: current rq which is locked
>   * @p: task to finish dispatching
>   * @qseq_at_dispatch: qseq when @p started getting dispatched
> @@ -5296,6 +5297,7 @@ static __printf(2, 3) bool handle_lockup
>  
>  /**
>   * scx_rcu_cpu_stall - sched_ext RCU CPU stall handler
> + * @stalled_mask: bit mask of stalled CPUs
>   *
>   * While there are various reasons why RCU CPU stalls can occur on a system
>   * that may not be caused by the current BPF scheduler, try kicking out the
> @@ -5390,6 +5392,7 @@ static DEFINE_IRQ_WORK(scx_hardlockup_ir
>  
>  /**
>   * scx_hardlockup - sched_ext hardlockup handler
> + * @cpu: the target CPU
>   *
>   * A poorly behaving BPF scheduler can trigger hard lockup by e.g. putting
>   * numerous affinitized tasks in a single queue and directing all CPUs at it.
> @@ -8426,7 +8429,7 @@ static void scx_dsq_insert_commit(struct
>  __bpf_kfunc_start_defs();
>  
>  /**
> - * scx_bpf_dsq_insert - Insert a task into the FIFO queue of a DSQ
> + * scx_bpf_dsq_insert___v2 - Insert a task into the FIFO queue of a DSQ
>   * @p: task_struct to insert
>   * @dsq_id: DSQ to insert into
>   * @slice: duration @p can run for in nsecs, 0 to keep the current value
> @@ -8756,7 +8759,7 @@ __bpf_kfunc void scx_bpf_dispatch_cancel
>  }
>  
>  /**
> - * scx_bpf_dsq_move_to_local - move a task from a DSQ to the current CPU's local DSQ
> + * scx_bpf_dsq_move_to_local___v2 - move a task from a DSQ to the current CPU's local DSQ
>   * @dsq_id: DSQ to move task from. Must be a user-created DSQ
>   * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
>   * @enq_flags: %SCX_ENQ_*
> @@ -9485,7 +9488,7 @@ __bpf_kfunc void scx_bpf_dsq_reenq(u64 d
>  }
>  
>  /**
> - * scx_bpf_reenqueue_local - Re-enqueue tasks on a local DSQ
> + * scx_bpf_reenqueue_local___v2 - Re-enqueue tasks on a local DSQ
>   * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
>   *
>   * Iterate over all of the tasks currently enqueued on the local DSQ of the

Re: [PATCH] sched_ext: repair kernel-doc comments

[Tejun Heo]

Hello,

On Thu, Jul 23, 2026 at 10:31:18AM -0700, Randy Dunlap wrote:
> Add missing function parameter descriptions and use the correct
> function name in kernel-doc comments to avoid kernel-doc warnings:

Applied to sched_ext/for-7.3 with Andrea's Reviewed-by added and the
subject capitalized.

Thanks.

--
tejun