[PATCH] seqlock: fix scoped_seqlock_read kernel-doc

Randy Dunlap posted 1 patch 2 weeks, 1 day ago
There is a newer version of this series
include/linux/seqlock.h |   13 ++++++-------
1 file changed, 6 insertions(+), 7 deletions(-)
[PATCH] seqlock: fix scoped_seqlock_read kernel-doc
Posted by Randy Dunlap 2 weeks, 1 day ago
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.

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
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>
---
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Will Deacon <will@kernel.org>

 include/linux/seqlock.h |   13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

--- linux-next-20260121.orig/include/linux/seqlock.h
+++ linux-next-20260121/include/linux/seqlock.h
@@ -1339,13 +1339,12 @@ static __always_inline void __scoped_seq
 	     __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
+ * 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:
  *