Skip to content

Commit f88a313

Browse files
rddunlapPeter Zijlstra
authored andcommitted
seqlock: fix scoped_seqlock_read kernel-doc
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: cc39f38 ("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
1 parent 944e3f7 commit f88a313

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

include/linux/seqlock.h

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1339,15 +1339,14 @@ static __always_inline void __scoped_seqlock_cleanup_ctx(struct ss_tmp **s)
13391339
__scoped_seqlock_next(&_s, _seqlock, _target))
13401340

13411341
/**
1342-
* scoped_seqlock_read (lock, ss_state) - execute the read side critical
1343-
* section without manual sequence
1344-
* counter handling or calls to other
1345-
* helpers
1346-
* @lock: pointer to seqlock_t protecting the data
1347-
* @ss_state: one of {ss_lock, ss_lock_irqsave, ss_lockless} indicating
1348-
* the type of critical read section
1349-
*
1350-
* Example:
1342+
* scoped_seqlock_read() - execute the read-side critical section
1343+
* without manual sequence counter handling
1344+
* or calls to other helpers
1345+
* @_seqlock: pointer to seqlock_t protecting the data
1346+
* @_target: an enum ss_state: one of {ss_lock, ss_lock_irqsave, ss_lockless}
1347+
* indicating the type of critical read section
1348+
*
1349+
* Example::
13511350
*
13521351
* scoped_seqlock_read (&lock, ss_lock) {
13531352
* // read-side critical section

0 commit comments

Comments
 (0)