diff options
| author |   Sebastian Andrzej Siewior <bigeasy@linutronix.de> | 2025-05-17 17:14:55 +0200 |
|---|---|---|
| committer |   Peter Zijlstra <peterz@infradead.org> | 2025-05-21 13:57:41 +0200 |
| commit | 73c6c02b4febbb2c2761e559f31af8c7b87e81a5 (patch) | |
| tree | 54df662507a7b222152865ed79c0d89417aae4ab /kernel | |
| parent | tools headers: Synchronize prctl.h ABI header (diff) | |
| download | wireguard-linux-73c6c02b4febbb2c2761e559f31af8c7b87e81a5.tar.xz wireguard-linux-73c6c02b4febbb2c2761e559f31af8c7b87e81a5.zip | |
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: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: André Almeida <andrealmeid@igalia.com>
Link: https://lore.kernel.org/r/20250517151455.1065363-6-bigeasy@linutronix.de
Diffstat (limited to 'kernel')
| -rw-r--r-- | kernel/futex/waitwake.c | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/kernel/futex/waitwake.c b/kernel/futex/waitwake.c index b3738fbe83c6..e2bbe5509ec2 100644 --- a/kernel/futex/waitwake.c +++ b/kernel/futex/waitwake.c @@ -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, |