Skip to content

Commit a28e884

Browse files
rddunlapPeter Zijlstra
authored andcommitted
seqlock: Fix multiple kernel-doc warnings
Fix kernel-doc warnings in <linux/seqlock.h>. ../include/linux/seqlock.h:152: warning: Incorrect use of kernel-doc format: * seqcount_LOCKNAME_init() - runtime initializer for seqcount_LOCKNAME_t ../include/linux/seqlock.h:164: warning: Incorrect use of kernel-doc format: * SEQCOUNT_LOCKTYPE() - Instantiate seqcount_LOCKNAME_t and helpers ../include/linux/seqlock.h:229: warning: Function parameter or member 'seq_name' not described in 'SEQCOUNT_LOCKTYPE_ZERO' ../include/linux/seqlock.h:229: warning: Function parameter or member 'assoc_lock' not described in 'SEQCOUNT_LOCKTYPE_ZERO' ../include/linux/seqlock.h:229: warning: Excess function parameter 'name' description in 'SEQCOUNT_LOCKTYPE_ZERO' ../include/linux/seqlock.h:229: warning: Excess function parameter 'lock' description in 'SEQCOUNT_LOCKTYPE_ZERO' ../include/linux/seqlock.h:695: warning: duplicate section name 'NOTE' Demote kernel-doc notation for the macros "seqcount_LOCKNAME_init()" and "SEQCOUNT_LOCKTYPE()"; scripts/kernel-doc does not handle them correctly. Rename function parameters in SEQCNT_LOCKNAME_ZERO() documentation to match the macro's argument names. Change the macro name in the documentation to SEQCOUNT_LOCKTYPE_ZERO() to match the macro's name. For raw_write_seqcount_latch(), rename the second NOTE: to NOTE2: to prevent a kernel-doc warning. However, the generated output is not quite as nice as it could be for this. Fix a typo: s/LOCKTYPR/LOCKTYPE/ Fixes: 0efc94c ("seqcount: Compress SEQCNT_LOCKNAME_ZERO()") Fixes: e4e9ab3 ("seqlock: Fold seqcount_LOCKNAME_init() definition") Fixes: a8772dc ("seqlock: Fold seqcount_LOCKNAME_t definition") Reported-by: kernel test robot <[email protected]> Signed-off-by: Randy Dunlap <[email protected]> Signed-off-by: Peter Zijlstra (Intel) <[email protected]> Link: https://lkml.kernel.org/r/[email protected]
1 parent a435b9a commit a28e884

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

include/linux/seqlock.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ static inline void seqcount_lockdep_reader_access(const seqcount_t *s)
138138
#endif
139139

140140
/**
141-
* typedef seqcount_LOCKNAME_t - sequence counter with LOCKTYPR associated
141+
* typedef seqcount_LOCKNAME_t - sequence counter with LOCKTYPE associated
142142
* @seqcount: The real sequence counter
143143
* @lock: Pointer to the associated spinlock
144144
*
@@ -148,7 +148,7 @@ static inline void seqcount_lockdep_reader_access(const seqcount_t *s)
148148
* that the write side critical section is properly serialized.
149149
*/
150150

151-
/**
151+
/*
152152
* seqcount_LOCKNAME_init() - runtime initializer for seqcount_LOCKNAME_t
153153
* @s: Pointer to the seqcount_LOCKNAME_t instance
154154
* @lock: Pointer to the associated LOCKTYPE
@@ -217,7 +217,7 @@ SEQCOUNT_LOCKTYPE(rwlock_t, rwlock, false, s->lock)
217217
SEQCOUNT_LOCKTYPE(struct mutex, mutex, true, s->lock)
218218
SEQCOUNT_LOCKTYPE(struct ww_mutex, ww_mutex, true, &s->lock->base)
219219

220-
/**
220+
/*
221221
* SEQCNT_LOCKNAME_ZERO - static initializer for seqcount_LOCKNAME_t
222222
* @name: Name of the seqcount_LOCKNAME_t instance
223223
* @lock: Pointer to the associated LOCKTYPE
@@ -688,7 +688,7 @@ static inline int raw_read_seqcount_t_latch(seqcount_t *s)
688688
* to miss an entire modification sequence, once it resumes it might
689689
* observe the new entry.
690690
*
691-
* NOTE:
691+
* NOTE2:
692692
*
693693
* When data is a dynamic data structure; one should use regular RCU
694694
* patterns to manage the lifetimes of the objects within.

0 commit comments

Comments
 (0)