linux-kernel - [PATCH RESEND v3 11/11] iopoll: update kerneldoc of read_poll_timeout

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>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <1599726112-4439-11-git-send-email-chunfeng.yun@mediatek.com>
Date:   Thu, 10 Sep 2020 16:21:52 +0800
From:   Chunfeng Yun <chunfeng.yun@...iatek.com>
To:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>
CC:     Mathias Nyman <mathias.nyman@...el.com>,
        Felipe Balbi <balbi@...nel.org>,
        Matthias Brugger <matthias.bgg@...il.com>,
        Douglas Anderson <dianders@...omium.org>,
        Chunfeng Yun <chunfeng.yun@...iatek.com>,
        Daniel Thompson <daniel.thompson@...aro.org>,
        "Eric W. Biederman" <ebiederm@...ssion.com>,
        Lee Jones <lee.jones@...aro.org>,
        Sumit Garg <sumit.garg@...aro.org>,
        Jann Horn <jannh@...gle.com>, Arnd Bergmann <arnd@...db.de>,
        Jason Yan <yanaijie@...wei.com>,
        Chuhong Yuan <hslester96@...il.com>,
        "Gustavo A. R. Silva" <gustavoars@...nel.org>,
        Ben Dooks <ben.dooks@...ethink.co.uk>,
        Saurav Girepunje <saurav.girepunje@...il.com>,
        <linux-usb@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        <linux-arm-kernel@...ts.infradead.org>,
        <linux-mediatek@...ts.infradead.org>,
        Alan Stern <stern@...land.harvard.edu>
Subject: [PATCH RESEND v3 11/11] iopoll: update kerneldoc of read_poll_timeout_atomic()

Arguments description of read_poll_timeout_atomic() is out of date,
update it.

Cc: Alan Stern <stern@...land.harvard.edu>
Signed-off-by: Chunfeng Yun <chunfeng.yun@...iatek.com>
---
v3: fix typo in commit message suggested by Sergei

v2: new patch, suggested by Alan
---
 include/linux/iopoll.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/iopoll.h b/include/linux/iopoll.h
index bc89ac6..2c8860e 100644
--- a/include/linux/iopoll.h
+++ b/include/linux/iopoll.h
@@ -60,8 +60,7 @@
 /**
  * read_poll_timeout_atomic - Periodically poll an address until a condition is
  * 				met or a timeout occurs
- * @op: accessor function (takes @addr as its only argument)
- * @addr: Address to poll
+ * @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).  Should
@@ -69,6 +68,7 @@
  *            Documentation/timers/timers-howto.rst).
  * @timeout_us: Timeout in us, 0 means never timeout
  * @delay_before_read: if it is true, delay @delay_us before read.
+ * @args: arguments for @op poll
  *
  * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
  * case, the last read value at @args is stored in @val.
-- 
1.9.1