]> www.infradead.org Git - users/jedix/linux-maple.git/commit
futex: Correct the kernedoc return value for futex_wait_setup().
authorSebastian Andrzej Siewior <bigeasy@linutronix.de>
Sat, 17 May 2025 15:14:55 +0000 (17:14 +0200)
committerPeter Zijlstra <peterz@infradead.org>
Wed, 21 May 2025 11:57:41 +0000 (13:57 +0200)
commit73c6c02b4febbb2c2761e559f31af8c7b87e81a5
tree54df662507a7b222152865ed79c0d89417aae4ab
parent4140e2b31bedd87bfc53362441165979aa4fc5d8
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
kernel/futex/waitwake.c