The read_poll_timeout macro has some incorrect documentation. @addr is referred to but that is now replaced with @args.
Update the macro documentation to make it more similar to the equivalent Linux documentation, which doesn't have this issue. Signed-off-by: Ronan Dalton <[email protected]> Cc: Ariel D'Alessandro <[email protected]> Cc: Marek Vasut <[email protected]> --- Changes for v2: - This is a new patch in the patch set Changes for v3: - No changes Changes for v4: - No changes include/linux/iopoll.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/include/linux/iopoll.h b/include/linux/iopoll.h index 0ee2bddaa83..d6573fafab0 100644 --- a/include/linux/iopoll.h +++ b/include/linux/iopoll.h @@ -12,16 +12,17 @@ #include <time.h> /** - * read_poll_timeout - Periodically poll an address until a condition is met or a timeout occurs - * @op: accessor function (takes @addr as its only argument) + * read_poll_timeout - Periodically poll an address until a condition is met or + * a timeout occurs + * @op: accessor function (takes @args as its arguments) * @val: Variable to read the value into * @cond: Break condition (usually involving @val) - * @sleep_us: Maximum time to sleep in us + * @sleep_us: Maximum time to sleep between reads in us (0 tight-loops). * @timeout_us: Timeout in us, 0 means never timeout * @args: arguments for @op poll * * Returns 0 on success and -ETIMEDOUT upon a timeout. In either - * case, the last read value at @addr is stored in @val. + * case, the last read value at @args is stored in @val. * * When available, you'll probably want to use one of the specialized * macros defined below rather than this macro directly. -- 2.53.0
