Commit 73c6c02b authored by Sebastian Andrzej Siewior's avatar Sebastian Andrzej Siewior Committed by Peter Zijlstra
Browse files

futex: Correct the kernedoc return value for futex_wait_setup(). 



The kerneldoc for futex_wait_setup() states it can return "0" or "<1".
This isn't true because the error case is "<0" not less than 1.

Document that <0 is returned on error. Drop the possible return values
and state possible reasons.

Signed-off-by: default avatarSebastian Andrzej Siewior <bigeasy@linutronix.de>
Signed-off-by: default avatarPeter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: default avatarAndré Almeida <andrealmeid@igalia.com>
Link: https://lore.kernel.org/r/20250517151455.1065363-6-bigeasy@linutronix.de
parent 4140e2b3

kernel/futex/waitwake.c

+2 −1
Original line number Diff line number Diff line
@@ -585,7 +585,8 @@ int futex_wait_multiple(struct futex_vector *vs, unsigned int count, 
 *

 * Return:

 *  -  0 - uaddr contains val and hb has been locked;

 *  - <1 - -EFAULT or -EWOULDBLOCK (uaddr does not contain val) and hb is unlocked

 *  - <0 - On error and the hb is unlocked. A possible reason: the uaddr can not

 *	   be read, does not contain the expected value or is not properly aligned.

 */

int futex_wait_setup(u32 __user *uaddr, u32 val, unsigned int flags,

		     struct futex_q *q, union futex_key *key2,