]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
stop_machine: Fix the documentation for a NULL cpus argument
authorThomas Weißschuh <thomas.weissschuh@linutronix.de>
Tue, 17 Feb 2026 13:11:11 +0000 (14:11 +0100)
committerPaul E. McKenney <paulmck@kernel.org>
Tue, 3 Mar 2026 23:35:51 +0000 (15:35 -0800)
commit48f7a50c027dd2abb9e7b8a6ecc8e531d87f2c21
tree04562a601980e554595b30a12c05fb95f73d7b30
parent6de23f81a5e08be8fbf5e8d7e9febc72a5b5f27f
stop_machine: Fix the documentation for a NULL cpus argument

A recent refactoring of the kernel-docs for stop machine changed the
description of the cpus parameter from "NULL = any online cpu"
to "NULL = run on each online CPU".

However the callback is only executed on a single CPU, not all of them.
The old wording was a bit ambiguous and could have been read both ways.

Reword the documentation to be correct again and hopefully also clearer.

Fixes: fc6f89dc7078 ("stop_machine: Improve kernel-doc function-header comments")
Signed-off-by: Thomas Weißschuh <thomas.weissschuh@linutronix.de>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Reviewed-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
include/linux/stop_machine.h