linux-kernel - [PATCH] genirq/timings: add kernel-doc for a function param

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20250111062954.910657-1-rdunlap@infradead.org>
Date: Fri, 10 Jan 2025 22:29:54 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Thomas Gleixner <tglx@...utronix.de>
Subject: [PATCH] genirq/timings: add kernel-doc for a function param

Add the description for @now to eliminate a kernel-doc warning.
(Is this function used? I don't see it being called.)

timings.c:537: warning: Function parameter or struct member 'now' not described in 'irq_timings_next_event'

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Thomas Gleixner <tglx@...utronix.de>
---
 kernel/irq/timings.c |    1 +
 1 file changed, 1 insertion(+)

--- linux-next-20250108.orig/kernel/irq/timings.c
+++ linux-next-20250108/kernel/irq/timings.c
@@ -509,6 +509,7 @@ static inline void irq_timings_store(int
 
 /**
  * irq_timings_next_event - Return when the next event is supposed to arrive
+ * @now: current time
  *
  * During the last busy cycle, the number of interrupts is incremented
  * and stored in the irq_timings structure. This information is