futex: Fix kernel-doc notation warning
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 9 Dec 2019 04:26:55 +0000 (20:26 -0800)
committerThomas Gleixner <tglx@linutronix.de>
Thu, 9 Jan 2020 12:23:40 +0000 (13:23 +0100)
Fix a kernel-doc warning in kernel/futex.c by adding notation
for @ret.

../kernel/futex.c:1187: warning: Function parameter or member 'ret' not described in 'wait_for_owner_exiting'

Fixes: 3ef240eaff36 ("futex: Prevent exit livelock")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/223be78c-f3c8-52df-836d-c5fb8e7907e9@infradead.org
kernel/futex.c

index 03c518e..0cf84c8 100644 (file)
@@ -1178,6 +1178,7 @@ out_error:
 
 /**
  * wait_for_owner_exiting - Block until the owner has exited
+ * @ret: owner's current futex lock status
  * @exiting:   Pointer to the exiting task
  *
  * Caller must hold a refcount on @exiting.