lkml.org 
[lkml]   [2020]   [Jan]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subject[tip: locking/urgent] futex: Fix kernel-doc notation warning
The following commit has been merged into the locking/urgent branch of tip:

Commit-ID: 51bfb1d11d6daf095addf9fe8471c20992caae0b
Gitweb: https://git.kernel.org/tip/51bfb1d11d6daf095addf9fe8471c20992caae0b
Author: Randy Dunlap <rdunlap@infradead.org>
AuthorDate: Sun, 08 Dec 2019 20:26:55 -08:00
Committer: Thomas Gleixner <tglx@linutronix.de>
CommitterDate: Thu, 09 Jan 2020 13:23:40 +01:00

futex: Fix kernel-doc notation warning

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 | 1 +
1 file changed, 1 insertion(+)

diff --git a/kernel/futex.c b/kernel/futex.c
index 03c518e..0cf84c8 100644
--- a/kernel/futex.c
+++ b/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.
\
 
 \ /
  Last update: 2020-01-09 13:29    [W:0.037 / U:0.936 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site