Commit 4477b060 authored by Randy Dunlap's avatar Randy Dunlap Committed by Thomas Gleixner
Browse files

timer/migration: Fix kernel-doc warnings for union tmigr_state 



Use the correct kernel-doc notation for nested structs/unions to
eliminate warnings:

timer_migration.h:119: warning: Incorrect use of kernel-doc format:          * struct - split state of tmigr_group
timer_migration.h:134: warning: Function parameter or struct member 'active' not described in 'tmigr_state'
timer_migration.h:134: warning: Function parameter or struct member 'migrator' not described in 'tmigr_state'
timer_migration.h:134: warning: Function parameter or struct member 'seq' not described in 'tmigr_state'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/all/20250111063156.910903-1-rdunlap@infradead.org
parent 4903e1ba

kernel/time/timer_migration.h

+9 −12
Original line number Diff line number Diff line
@@ -110,13 +110,8 @@ struct tmigr_cpu { 
 * union tmigr_state - state of tmigr_group

 * @state:	Combined version of the state - only used for atomic

 *		read/cmpxchg function

 * @struct:	Split version of the state - only use the struct members to

 * &anon struct: Split version of the state - only use the struct members to

 *		update information to stay independent of endianness

 */

union tmigr_state {

	u32 state;

	/**

	 * struct - split state of tmigr_group

 * @active:	Contains each mask bit of the active children

 * @migrator:	Contains mask of the child which is migrator

 * @seq:	Sequence counter needs to be increased when an update
@@ -126,6 +121,8 @@ union tmigr_state { 
 *		given in the documentation at the begin of

 *		timer_migration.c.

 */

union tmigr_state {

	u32 state;

	struct {

		u8	active;

		u8	migrator;