Commit a28e884b authored Aug 16, 2020 by Randy Dunlap Committed by Peter Zijlstra Aug 26, 2020

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: 0efc94c5 ("seqcount: Compress SEQCNT_LOCKNAME_ZERO()")
Fixes: e4e9ab3f ("seqlock: Fold seqcount_LOCKNAME_init() definition")
Fixes: a8772dcc ("seqlock: Fold seqcount_LOCKNAME_t definition")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Link: https://lkml.kernel.org/r/20200817000200.20993-1-rdunlap@infradead.org

parent a435b9a1

include/linux/seqlock.h

+4 −4

Original line number	Diff line number	Diff line
		@@ -138,7 +138,7 @@ static inline void seqcount_lockdep_reader_access(const seqcount_t *s)
		#endif

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

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

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

Admin message