Skip to content

Commit 48f7a50

Browse files
t-8chpaulmckrcu
authored andcommitted
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: fc6f89d ("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>
1 parent 6de23f8 commit 48f7a50

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

include/linux/stop_machine.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ static inline void print_stop_info(const char *log_lvl, struct task_struct *task
9999
* stop_machine: freeze the machine on all CPUs and run this function
100100
* @fn: the function to run
101101
* @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)
103103
*
104104
* Description: This causes a thread to be scheduled on every CPU, which
105105
* will run with interrupts disabled. Each CPU specified by @cpus will
@@ -133,7 +133,7 @@ int stop_machine(cpu_stop_fn_t fn, void *data, const struct cpumask *cpus);
133133
* stop_machine_cpuslocked: freeze the machine on all CPUs and run this function
134134
* @fn: the function to run
135135
* @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)
137137
*
138138
* Same as above. Avoids nested calls to cpus_read_lock().
139139
*

0 commit comments

Comments
 (0)