[PATCH] futex: fix kernel-doc notation warning

From: Randy Dunlap
Date: Sun Dec 08 2019 - 23:27:20 EST


From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

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@xxxxxxxxxxxxx>
Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
Cc: Ingo Molnar <mingo@xxxxxxxxxx>
Cc: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
Cc: Darren Hart <dvhart@xxxxxxxxxxxxx>
---
kernel/futex.c | 1 +
1 file changed, 1 insertion(+)

--- linux-next-20191209.orig/kernel/futex.c
+++ linux-next-20191209/kernel/futex.c
@@ -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.