linux-kernel - [PATCH] iopoll: fix parameter names in kernel-doc

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: <20251214202016.2198503-1-rdunlap@infradead.org>
Date: Sun, 14 Dec 2025 12:20:16 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Ville Syrjälä <ville.syrjala@...ux.intel.com>,
	Jani Nikula <jani.nikula@...el.com>,
	intel-gfx@...ts.freedesktop.org,
	intel-xe@...ts.freedesktop.org
Subject: [PATCH] iopoll: fix parameter names in kernel-doc

Correct the parameter names to avoid kernel-doc warnings:

Warning: include/linux/iopoll.h:169 function parameter 'sleep_us' not
 described in 'read_poll_timeout_atomic'
Warning: ../include/linux/iopoll.h:169 function parameter
 'sleep_before_read' not described in 'read_poll_timeout_atomic'

Fixes: 9df8043a546d ("iopoll: Generalize read_poll_timeout() into poll_timeout_us()")
Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
---
Cc: Ville Syrjälä <ville.syrjala@...ux.intel.com>
Cc: Jani Nikula <jani.nikula@...el.com>
Cc: intel-gfx@...ts.freedesktop.org
Cc: intel-xe@...ts.freedesktop.org
---
 include/linux/iopoll.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

--- linux-next-20251201.orig/include/linux/iopoll.h
+++ linux-next-20251201/include/linux/iopoll.h
@@ -150,16 +150,16 @@
  * @op: accessor function (takes @args as its arguments)
  * @val: Variable to read the value into
  * @cond: Break condition (usually involving @val)
- * @delay_us: Time to udelay between reads in us (0 tight-loops). Please
+ * @sleep_us: Time to udelay between reads in us (0 tight-loops). Please
  *            read udelay() function description for details and
  *            limitations.
  * @timeout_us: Timeout in us, 0 means never timeout
- * @delay_before_read: if it is true, delay @delay_us before read.
+ * @sleep_before_read: if it is true, delay @sleep_us before read.
  * @args: arguments for @op poll
  *
  * This macro does not rely on timekeeping.  Hence it is safe to call even when
  * timekeeping is suspended, at the expense of an underestimation of wall clock
- * time, which is rather minimal with a non-zero delay_us.
+ * time, which is rather minimal with a non-zero @sleep_us.
  *
  * When available, you'll probably want to use one of the specialized
  * macros defined below rather than this macro directly.