mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Anna-Maria Behnsen <anna-maria@linutronix.de>,
	Frederic Weisbecker <frederic@kernel.org>,
	Thomas Gleixner <tglx@kernel.org>
Subject: [PATCH 1/2] posix-timers: clean up kernel-doc warnings
Date: Sun, 19 Jul 2026 20:12:35 -0700	[thread overview]
Message-ID: <20260720031236.3070575-1-rdunlap@infradead.org> (raw)

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'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Anna-Maria Behnsen <anna-maria@linutronix.de>
Cc: Frederic Weisbecker <frederic@kernel.org>
Cc: Thomas Gleixner <tglx@kernel.org>

 include/linux/posix-timers.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20260717.orig/include/linux/posix-timers.h
+++ linux-next-20260717/include/linux/posix-timers.h
@@ -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)

             reply	other threads:[~2026-07-20  3:12 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-20  3:12 Randy Dunlap [this message]
2026-07-20  3:12 ` [PATCH 2/2] posix-cpu-timers: avoid " Randy Dunlap
2026-07-20 14:07   ` [tip: timers/core] posix-cpu-timers: Avoid " tip-bot2 for Randy Dunlap
2026-07-20 14:07 ` [tip: timers/core] posix-timers: Clean up " tip-bot2 for Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260720031236.3070575-1-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=anna-maria@linutronix.de \
    --cc=frederic@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=tglx@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®