The Linux Kernel Mailing List
 help / color / mirror / Atom feed
* [PATCH] sched_ext: Documentation: Fix ops table header reference
@ 2026-07-07  9:45 luoliang
  2026-07-07 14:55 ` Andrea Righi
  2026-07-07 22:28 ` Tejun Heo
  0 siblings, 2 replies; 3+ messages in thread
From: luoliang @ 2026-07-07  9:45 UTC (permalink / raw)
  To: Tejun Heo
  Cc: Jonathan Corbet, Shuah Khan, Andrea Righi, linux-doc,
	linux-kernel, Liang Luo

From: Liang Luo <luoliang@kylinos.cn>

The "Where to Look" and "ABI Instability" sections state that the ops
table is defined in include/linux/sched/ext.h. However, struct
sched_ext_ops is actually defined in kernel/sched/ext/internal.h, along
with the SCX_OPS_* flags; include/linux/sched/ext.h holds the core data
structures (struct sched_ext_entity, struct scx_dispatch_q, ...) and the
DSQ constants. Point the ops table references to the correct header.

Signed-off-by: Liang Luo <luoliang@kylinos.cn>
---
 Documentation/scheduler/sched-ext.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Documentation/scheduler/sched-ext.rst b/Documentation/scheduler/sched-ext.rst
index 4b1ffd03f516..2771ea4cc14a 100644
--- a/Documentation/scheduler/sched-ext.rst
+++ b/Documentation/scheduler/sched-ext.rst
@@ -493,8 +493,9 @@ a freshly woken up task gets on a CPU.
 Where to Look
 =============
 
-* ``include/linux/sched/ext.h`` defines the core data structures, ops table
-  and constants.
+* ``include/linux/sched/ext.h`` defines the core data structures and
+  constants, while the ops table (``struct sched_ext_ops``) is defined in
+  ``kernel/sched/ext/internal.h``.
 
 * ``kernel/sched/ext/ext.c`` contains sched_ext core implementation and helpers.
   The functions prefixed with ``scx_bpf_`` can be called from the BPF
@@ -555,7 +556,8 @@ ABI Instability
 ===============
 
 The APIs provided by sched_ext to BPF schedulers programs have no stability
-guarantees. This includes the ops table callbacks and constants defined in
+guarantees. This includes the ops table callbacks defined in
+``kernel/sched/ext/internal.h`` and the constants defined in
 ``include/linux/sched/ext.h``, as well as the ``scx_bpf_`` kfuncs defined in
 ``kernel/sched/ext/ext.c`` and ``kernel/sched/ext/idle.c``.
 
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] sched_ext: Documentation: Fix ops table header reference
  2026-07-07  9:45 [PATCH] sched_ext: Documentation: Fix ops table header reference luoliang
@ 2026-07-07 14:55 ` Andrea Righi
  2026-07-07 22:28 ` Tejun Heo
  1 sibling, 0 replies; 3+ messages in thread
From: Andrea Righi @ 2026-07-07 14:55 UTC (permalink / raw)
  To: luoliang; +Cc: Tejun Heo, Jonathan Corbet, Shuah Khan, linux-doc, linux-kernel

On Tue, Jul 07, 2026 at 05:45:38PM +0800, luoliang@kylinos.cn wrote:
> From: Liang Luo <luoliang@kylinos.cn>
> 
> The "Where to Look" and "ABI Instability" sections state that the ops
> table is defined in include/linux/sched/ext.h. However, struct
> sched_ext_ops is actually defined in kernel/sched/ext/internal.h, along
> with the SCX_OPS_* flags; include/linux/sched/ext.h holds the core data
> structures (struct sched_ext_entity, struct scx_dispatch_q, ...) and the
> DSQ constants. Point the ops table references to the correct header.
> 
> Signed-off-by: Liang Luo <luoliang@kylinos.cn>

Looks good to me.

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

Thanks,
-Andrea

> ---
>  Documentation/scheduler/sched-ext.rst | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/scheduler/sched-ext.rst b/Documentation/scheduler/sched-ext.rst
> index 4b1ffd03f516..2771ea4cc14a 100644
> --- a/Documentation/scheduler/sched-ext.rst
> +++ b/Documentation/scheduler/sched-ext.rst
> @@ -493,8 +493,9 @@ a freshly woken up task gets on a CPU.
>  Where to Look
>  =============
>  
> -* ``include/linux/sched/ext.h`` defines the core data structures, ops table
> -  and constants.
> +* ``include/linux/sched/ext.h`` defines the core data structures and
> +  constants, while the ops table (``struct sched_ext_ops``) is defined in
> +  ``kernel/sched/ext/internal.h``.
>  
>  * ``kernel/sched/ext/ext.c`` contains sched_ext core implementation and helpers.
>    The functions prefixed with ``scx_bpf_`` can be called from the BPF
> @@ -555,7 +556,8 @@ ABI Instability
>  ===============
>  
>  The APIs provided by sched_ext to BPF schedulers programs have no stability
> -guarantees. This includes the ops table callbacks and constants defined in
> +guarantees. This includes the ops table callbacks defined in
> +``kernel/sched/ext/internal.h`` and the constants defined in
>  ``include/linux/sched/ext.h``, as well as the ``scx_bpf_`` kfuncs defined in
>  ``kernel/sched/ext/ext.c`` and ``kernel/sched/ext/idle.c``.
>  
> -- 
> 2.43.0
> 

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] sched_ext: Documentation: Fix ops table header reference
  2026-07-07  9:45 [PATCH] sched_ext: Documentation: Fix ops table header reference luoliang
  2026-07-07 14:55 ` Andrea Righi
@ 2026-07-07 22:28 ` Tejun Heo
  1 sibling, 0 replies; 3+ messages in thread
From: Tejun Heo @ 2026-07-07 22:28 UTC (permalink / raw)
  To: Liang Luo
  Cc: Jonathan Corbet, Shuah Khan, Andrea Righi, Emil Tsalapatis,
	linux-doc, linux-kernel

Applied to sched_ext/for-7.2-fixes.

Thanks.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-07-07 22:28 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-07-07  9:45 [PATCH] sched_ext: Documentation: Fix ops table header reference luoliang
2026-07-07 14:55 ` Andrea Righi
2026-07-07 22:28 ` Tejun Heo

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox