Skip to content

Commit 4477b06

Browse files
rddunlapKAGA-KOKO
authored andcommitted
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: Randy Dunlap <[email protected]> Signed-off-by: Thomas Gleixner <[email protected]> Link: https://lore.kernel.org/all/[email protected]
1 parent 4903e1b commit 4477b06

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

kernel/time/timer_migration.h

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -110,22 +110,19 @@ struct tmigr_cpu {
110110
* union tmigr_state - state of tmigr_group
111111
* @state: Combined version of the state - only used for atomic
112112
* read/cmpxchg function
113-
* @struct: Split version of the state - only use the struct members to
113+
* &anon struct: Split version of the state - only use the struct members to
114114
* update information to stay independent of endianness
115+
* @active: Contains each mask bit of the active children
116+
* @migrator: Contains mask of the child which is migrator
117+
* @seq: Sequence counter needs to be increased when an update
118+
* to the tmigr_state is done. It prevents a race when
119+
* updates in the child groups are propagated in changed
120+
* order. Detailed information about the scenario is
121+
* given in the documentation at the begin of
122+
* timer_migration.c.
115123
*/
116124
union tmigr_state {
117125
u32 state;
118-
/**
119-
* struct - split state of tmigr_group
120-
* @active: Contains each mask bit of the active children
121-
* @migrator: Contains mask of the child which is migrator
122-
* @seq: Sequence counter needs to be increased when an update
123-
* to the tmigr_state is done. It prevents a race when
124-
* updates in the child groups are propagated in changed
125-
* order. Detailed information about the scenario is
126-
* given in the documentation at the begin of
127-
* timer_migration.c.
128-
*/
129126
struct {
130127
u8 active;
131128
u8 migrator;

0 commit comments

Comments
 (0)