tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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>

authored by

Thomas Weißschuh and committed by
Paul E. McKenney 48f7a50c 6de23f81

+2 -2
+2 -2
include/linux/stop_machine.h
··· 99 99 * stop_machine: freeze the machine on all CPUs and run this function 100 100 * @fn: the function to run 101 101 * @data: the data ptr to pass to @fn() 102 - * @cpus: the cpus to run @fn() on (NULL = run on each online CPU) 102 + * @cpus: the cpus to run @fn() on (NULL = one unspecified online CPU) 103 103 * 104 104 * Description: This causes a thread to be scheduled on every CPU, which 105 105 * will run with interrupts disabled. Each CPU specified by @cpus will ··· 133 133 * stop_machine_cpuslocked: freeze the machine on all CPUs and run this function 134 134 * @fn: the function to run 135 135 * @data: the data ptr to pass to @fn() 136 - * @cpus: the cpus to run @fn() on (NULL = run on each online CPU) 136 + * @cpus: the cpus to run @fn() on (NULL = one unspecified online CPU) 137 137 * 138 138 * Same as above. Avoids nested calls to cpus_read_lock(). 139 139 *