sched: fix cid_lock kernel-doc warnings
PATCH 1/1 sched: fix cid_lock kernel-doc warnings
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 linekernel/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
--- kernel/sched/core.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
kernel/sched/core.c +2 -2
@@ -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
Quoted 8 lines · Randy Dunlap
Fix kernel-doc warnings for
cid_lockanduse_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 linekernel/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.
Thanks,
Mathieu
Quoted 30 lines
Fixes 223baf9d17f2 ("sched: Fix performance regression introduced by mm_cid")Signed-off-by Randy Dunlap <[email protected]>Cc Mathieu Desnoyers <[email protected]>Cc "Peter Zijlstra (Intel)" <[email protected]>Cc Ingo Molnar <[email protected]>--- kernel/sched/core.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)diff --
a/kernel/sched/core.cb/kernel/sched/core.ckernel/sched/core.c +2
-2@@ -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
Signature · 3 lines
Mathieu Desnoyers EfficiOS Inc. https://www.efficios.com
Peter Zijlstra
maintainerQuoted 10 lines · Randy Dunlap
Fix kernel-doc warnings for
cid_lockanduse_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 linekernel/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 lineFixes 223baf9d17f2 ("sched: Fix performance regression introduced by mm_cid")Signed-off-by Randy Dunlap <[email protected]>
Blergh, so mostly I avoid kerneldoc like the plague; because then you get random people doing 'fixups' that end up making the actual comment unreadable garbage.
Mostly my answer to any such patch is to simply remove the extra * and call it fixed.
But now the thing presumes to know better? :-(
Anyway, in this case I suppose we can add it on and see, there's still a fair number of actual kerneldoc comments in that file.
Quoted 24 lines
kernel/sched/core.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)diff --
a/kernel/sched/core.cb/kernel/sched/core.ckernel/sched/core.c +2
-2@@ -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
Peter Zijlstra
maintainerQuoted 12 lines · Peter Zijlstra
Quoted 10 lines · Randy Dunlap
Fix kernel-doc warnings for
cid_lockanduse_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 linekernel/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 lineFixes 223baf9d17f2 ("sched: Fix performance regression introduced by mm_cid")Signed-off-by Randy Dunlap <[email protected]>
Quoted 8 lines
Blergh, so mostly I avoid kerneldoc like the plague; because then you get random people doing 'fixups' that end up making the actual comment unreadable garbage.
Mostly my answer to any such patch is to simply remove the extra * and call it fixed.
But now the thing presumes to know better? :-(
Bah, I should go sleep more.. this removes them. All good.
The following commit has been merged into the sched/urgent branch of tip:
The following commit has been merged into the sched/urgent branch of tip:
Commit-ID: 0019a2d4b7e37a983d133d42b707b8a3018ae6f4 Gitweb: https://git.kernel.org/tip/0019a2d4b7e37a983d133d42b707b8a3018ae6f4 Author: Randy Dunlap <[email protected]> AuthorDate: Thu, 27 Apr 2023 20:11:11 -07:00 Committer: Peter Zijlstra <[email protected]> CommitterDate: Mon, 08 May 2023 10:58:28 +02:00
sched: fix cid_lock kernel-doc warnings
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 linekernel/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
--- kernel/sched/core.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
kernel/sched/core.c +2 -2
@@ -11492,7 +11492,7 @@ void call_trace_sched_update_nr_running(struct rq *rq, int count)#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(struct rq *rq, int count)*/ 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