posix-timers: clean up kernel-doc warnings
PATCH 1/2 posix-timers: clean up kernel-doc warnings
Use the struct keyword when describing a struct. Add missing kernel-doc for @it_pid_type.
Warning: ./include/linux/posix-timers.h:58 cannot understand
function prototype: 'struct cpu_timer'
Warning: ./include/linux/posix-timers.h:222 struct member
'it_pid_type' not described in 'k_itimer'
---
Cc: Anna-Maria Behnsen <[email protected]>
Cc: Frederic Weisbecker <[email protected]>
Cc: Thomas Gleixner <[email protected]>
include/linux/posix-timers.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
include/linux/posix-timers.h +2 -1
@@ -47,7 +47,7 @@ static inline bool clockid_aux_valid(clo#include <linux/signal_types.h> /** -* cpu_timer - Posix CPU timer representation for k_itimer +* struct cpu_timer - Posix CPU timer representation for k_itimer * @node: timerqueue node to queue in the task/sig * @head: timerqueue head on which this timer is queued * @pid: Pointer to target task PID
@@ -174,6 +174,7 @@ static inline void posix_cputimers_init_* @it_sigqueue_seq: The sequence count at the point where the signal was queued * @it_sigev_notify: The notify word of sigevent struct for signal delivery * @it_interval: The interval for periodic timers +* @it_pid_type: The type of the PID * @it_signal: Pointer to the creators signal struct * @it_pid: The pid of the process/task targeted by the signal * @it_process: The task to wakeup on clock_nanosleep (CPU timers)
PATCH 2/2 posix-cpu-timers: avoid kernel-doc warnings
Use the struct keyword when describing a struct. Without that, the type defaults to function.
Warning: ./include/linux/posix-timers_types.h:40 cannot understand
function prototype: 'struct posix_cputimer_base'
Warning: ./include/linux/posix-timers_types.h:55 cannot understand
function prototype: 'struct posix_cputimers'
Warning: ./include/linux/posix-timers_types.h:67 cannot understand
function prototype: 'struct posix_cputimers_work'
---
Cc: Anna-Maria Behnsen <[email protected]>
Cc: Frederic Weisbecker <[email protected]>
Cc: Thomas Gleixner <[email protected]>
include/linux/posix-timers_types.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
include/linux/posix-timers_types.h +4 -3
@@ -34,7 +34,7 @@#ifdef CONFIG_POSIX_TIMERS /** -* posix_cputimer_base - Container per posix CPU clock +* struct posix_cputimer_base - Container per posix CPU clock * @nextevt: Earliest-expiration cache * @tqhead: timerqueue head for cpu_timers */
@@ -44,7 +44,7 @@ struct posix_cputimer_base { };/** -* posix_cputimers - Container for posix CPU timer related data +* struct posix_cputimers - Container for posix CPU timer related data * @bases: Base container for posix CPU clocks * @timers_active: Timers are queued. * @expiry_active: Timer expiry is active. Used for
@@ -60,7 +60,8 @@ struct posix_cputimers { };/** -* posix_cputimers_work - Container for task work based posix CPU timer expiry +* struct posix_cputimers_work - Container for task work based posix +* CPU timer expiry * @work: The task work to be scheduled * @mutex: Mutex held around expiry in context of this task work * @scheduled: @work has been scheduled already, no further processing
[tip: timers/core] posix-cpu-timers: Avoid kernel-doc warnings
The following commit has been merged into the timers/core branch of tip:
The following commit has been merged into the timers/core branch of tip:
Commit-ID: 98680a85df888f86e56ec12d78b2de730426e5af Gitweb: https://git.kernel.org/tip/98680a85df888f86e56ec12d78b2de730426e5af Author: Randy Dunlap <[email protected]> AuthorDate: Sun, 19 Jul 2026 20:12:36 -07:00 Committer: Thomas Gleixner <[email protected]> CommitterDate: Mon, 20 Jul 2026 16:05:42 +02:00
posix-cpu-timers: Avoid kernel-doc warnings
Use the struct keyword when describing a struct. Without that, the type defaults to function.
Warning: ./include/linux/posix-timers_types.h:40 cannot understand
function prototype: 'struct posix_cputimer_base'
Warning: ./include/linux/posix-timers_types.h:55 cannot understand
function prototype: 'struct posix_cputimers'
Warning: ./include/linux/posix-timers_types.h:67 cannot understand
function prototype: 'struct posix_cputimers_work'
--- include/linux/posix-timers_types.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
include/linux/posix-timers_types.h +3 -3
@@ -34,7 +34,7 @@#ifdef CONFIG_POSIX_TIMERS /** -* posix_cputimer_base - Container per posix CPU clock +* struct posix_cputimer_base - Container per posix CPU clock * @nextevt: Earliest-expiration cache * @tqhead: timerqueue head for cpu_timers */
@@ -44,7 +44,7 @@ struct posix_cputimer_base { };/** -* posix_cputimers - Container for posix CPU timer related data +* struct posix_cputimers - Container for posix CPU timer related data * @bases: Base container for posix CPU clocks * @timers_active: Timers are queued. * @expiry_active: Timer expiry is active. Used for
@@ -60,7 +60,7 @@ struct posix_cputimers { };/** -* posix_cputimers_work - Container for task work based posix CPU timer expiry +* struct posix_cputimers_work - Container for task work based posix CPU timer expiry * @work: The task work to be scheduled * @mutex: Mutex held around expiry in context of this task work * @scheduled: @work has been scheduled already, no further processing
[tip: timers/core] posix-timers: Clean up kernel-doc warnings
In reply to Randy DunlapThe following commit has been merged into the timers/core branch of tip:
The following commit has been merged into the timers/core branch of tip:
Commit-ID: 151ce4cf88cf2ab647d14064140f516bd78209b2 Gitweb: https://git.kernel.org/tip/151ce4cf88cf2ab647d14064140f516bd78209b2 Author: Randy Dunlap <[email protected]> AuthorDate: Sun, 19 Jul 2026 20:12:35 -07:00 Committer: Thomas Gleixner <[email protected]> CommitterDate: Mon, 20 Jul 2026 16:05:42 +02:00
posix-timers: Clean up kernel-doc warnings
Use the struct keyword when describing a struct.
Add missing kernel-doc for @it_pid_type.
Warning: ./include/linux/posix-timers.h:58 cannot understand
function prototype: 'struct cpu_timer'
Warning: ./include/linux/posix-timers.h:222 struct member
'it_pid_type' not described in 'k_itimer'
--- include/linux/posix-timers.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
include/linux/posix-timers.h +2 -1
@@ -47,7 +47,7 @@ static inline bool clockid_aux_valid(clockid_t id)#include <linux/signal_types.h> /** -* cpu_timer - Posix CPU timer representation for k_itimer +* struct cpu_timer - Posix CPU timer representation for k_itimer * @node: timerqueue node to queue in the task/sig * @head: timerqueue head on which this timer is queued * @pid: Pointer to target task PID
@@ -174,6 +174,7 @@ static inline void posix_cputimers_init_work(void) { }* @it_sigqueue_seq: The sequence count at the point where the signal was queued * @it_sigev_notify: The notify word of sigevent struct for signal delivery * @it_interval: The interval for periodic timers +* @it_pid_type: The type of the PID * @it_signal: Pointer to the creators signal struct * @it_pid: The pid of the process/task targeted by the signal * @it_process: The task to wakeup on clock_nanosleep (CPU timers)