| From 96ad8c6c07c0a6a40108d2268e5973fb051e665f Mon Sep 17 00:00:00 2001 |
| From: Sasha Levin <sashal@kernel.org> |
| Date: Fri, 23 Jan 2026 10:37:49 -0800 |
| Subject: seqlock: fix scoped_seqlock_read kernel-doc |
| |
| From: Randy Dunlap <rdunlap@infradead.org> |
| |
| [ Upstream commit f88a31308db6a856229150039b0f56d59696ed31 ] |
| |
| Eliminate all kernel-doc warnings in seqlock.h: |
| |
| - correct the macro to have "()" immediately following the macro name |
| - don't include the macro parameters in the short description (first line) |
| - make the parameter names in the comments match the actual macro |
| parameter names. |
| - use "::" for the Example |
| |
| WARNING: include/linux/seqlock.h:1341 This comment starts with '/**', but isn't a kernel-doc comment. |
| * scoped_seqlock_read (lock, ss_state) - execute the read side critical |
| Documentation/locking/seqlock:242: include/linux/seqlock.h:1351: WARNING: |
| Definition list ends without a blank line; unexpected unindent. [docutils] |
| Warning: include/linux/seqlock.h:1357 function parameter '_seqlock' not described in 'scoped_seqlock_read' |
| Warning: include/linux/seqlock.h:1357 function parameter '_target' not described in 'scoped_seqlock_read' |
| |
| Fixes: cc39f3872c08 ("seqlock: Introduce scoped_seqlock_read()") |
| Signed-off-by: Randy Dunlap <rdunlap@infradead.org> |
| Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org> |
| Link: https://patch.msgid.link/20260123183749.3997533-1-rdunlap@infradead.org |
| Signed-off-by: Sasha Levin <sashal@kernel.org> |
| --- |
| include/linux/seqlock.h | 17 ++++++++--------- |
| 1 file changed, 8 insertions(+), 9 deletions(-) |
| |
| diff --git a/include/linux/seqlock.h b/include/linux/seqlock.h |
| index 221123660e710..f827cc3cb1460 100644 |
| --- a/include/linux/seqlock.h |
| +++ b/include/linux/seqlock.h |
| @@ -1303,15 +1303,14 @@ __scoped_seqlock_next(struct ss_tmp *sst, seqlock_t *lock, enum ss_state target) |
| __scoped_seqlock_next(&_s, _seqlock, _target)) |
| |
| /** |
| - * scoped_seqlock_read (lock, ss_state) - execute the read side critical |
| - * section without manual sequence |
| - * counter handling or calls to other |
| - * helpers |
| - * @lock: pointer to seqlock_t protecting the data |
| - * @ss_state: one of {ss_lock, ss_lock_irqsave, ss_lockless} indicating |
| - * the type of critical read section |
| - * |
| - * Example: |
| + * scoped_seqlock_read() - execute the read-side critical section |
| + * without manual sequence counter handling |
| + * or calls to other helpers |
| + * @_seqlock: pointer to seqlock_t protecting the data |
| + * @_target: an enum ss_state: one of {ss_lock, ss_lock_irqsave, ss_lockless} |
| + * indicating the type of critical read section |
| + * |
| + * Example:: |
| * |
| * scoped_seqlock_read (&lock, ss_lock) { |
| * // read-side critical section |
| -- |
| 2.51.0 |
| |
