Skip to content

Commit 1ccc861

Browse files
rddunlapjmberg-intel
authored andcommitted
um: time-travel: clean up kernel-doc warnings
Repair all kernel-doc warnings in um_timetravel.h: - add one enum description - mark "reserve" as private - use a leading '@' on current_time Warning: include/uapi/linux/um_timetravel.h:59 Enum value 'UM_TIMETRAVEL_SHARED_MAX_FDS' not described in enum 'um_timetravel_shared_mem_fds' Warning: include/uapi/linux/um_timetravel.h:245 union member 'reserve' not described in 'um_timetravel_schedshm_client' Warning: include/uapi/linux/um_timetravel.h:288 struct member 'current_time' not described in 'um_timetravel_schedshm' Signed-off-by: Randy Dunlap <[email protected]> Link: https://patch.msgid.link/[email protected] Signed-off-by: Johannes Berg <[email protected]>
1 parent d46dfb3 commit 1ccc861

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

include/uapi/linux/um_timetravel.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ enum um_timetravel_shared_mem_fds {
5656
* in the control message
5757
*/
5858
UM_TIMETRAVEL_SHARED_LOGFD,
59+
/**
60+
* @UM_TIMETRAVEL_SHARED_MAX_FDS: number of fds listed here
61+
*/
5962
UM_TIMETRAVEL_SHARED_MAX_FDS,
6063
};
6164

@@ -242,6 +245,7 @@ union um_timetravel_schedshm_client {
242245
__u64 req_time;
243246
__u64 name;
244247
};
248+
/* private: */
245249
char reserve[128]; /* reserved for future usage */
246250
};
247251

@@ -264,7 +268,7 @@ union um_timetravel_schedshm_client {
264268
* is made by any client. Clients also must update this value when they
265269
* insert/update an own request into the shared memory while not running
266270
* themselves, and the new request is before than the current value.
267-
* current_time: Current time, can only be set by the client in running state
271+
* @current_time: Current time, can only be set by the client in running state
268272
* (indicated by @running_id), though that client may only run until @free_until,
269273
* so it must remain smaller than @free_until.
270274
* @running_id: The current client in state running, set before a client is

0 commit comments

Comments
 (0)