[PATCH] sched_ext: Fix stale @cgroup_id in sched_ext_ops kernel-doc

luoliang@kylinos.cn posted 1 patch 2 months ago
kernel/sched/ext/internal.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] sched_ext: Fix stale @cgroup_id in sched_ext_ops kernel-doc
Posted by luoliang@kylinos.cn 2 months ago
From: Liang Luo <luoliang@kylinos.cn>

The kernel-doc comment for sched_ext_ops::sub_cgroup_id uses the old
@cgroup_id name, which no longer matches the struct member. This
produces two kernel-doc warnings:

  Warning: struct member sub_cgroup_id not described in sched_ext_ops
  Warning: Excess struct member cgroup_id description in sched_ext_ops

Update the @param name to match the actual member.

Signed-off-by: Liang Luo <luoliang@kylinos.cn>
---
 kernel/sched/ext/internal.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/sched/ext/internal.h b/kernel/sched/ext/internal.h
index 673059fa9d72..9145adcb9589 100644
--- a/kernel/sched/ext/internal.h
+++ b/kernel/sched/ext/internal.h
@@ -809,7 +809,7 @@ struct sched_ext_ops {
 	u64 hotplug_seq;
 
 	/**
-	 * @cgroup_id: When >1, attach the scheduler as a sub-scheduler on the
+	 * @sub_cgroup_id: When >1, attach the scheduler as a sub-scheduler on the
 	 * specified cgroup.
 	 */
 	u64 sub_cgroup_id;
-- 
2.43.0
Re: [PATCH] sched_ext: Fix stale @cgroup_id in sched_ext_ops kernel-doc
Posted by Tejun Heo 2 months ago
Applied to sched_ext/for-7.3 with the comment rewrapped to stay under 80
columns.

Thanks.

--
tejun