Skip to content

Commit 949cb79

Browse files
committed
smp: Fix up and expand the smp_call_function_many() kerneldoc
JIRA: https://issues.redhat.com/browse/RHEL-121178 commit ccf0935 Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Date: Tue, 9 Sep 2025 13:44:14 +0200 smp: Fix up and expand the smp_call_function_many() kerneldoc The smp_call_function_many() kerneldoc comment got out of sync with the function definition (bool parameter "wait" is incorrectly described as a bitmask in it), so fix it up by copying the "wait" description from the smp_call_function() kerneldoc and add information regarding the handling of the local CPU to it. Fixes: 49b3bd2 ("smp: Fix all kernel-doc warnings") Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Waiman Long <longman@redhat.com>
1 parent 1dc96e5 commit 949cb79

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

kernel/smp.c

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -884,16 +884,15 @@ static void smp_call_function_many_cond(const struct cpumask *mask,
884884
* @mask: The set of cpus to run on (only runs on online subset).
885885
* @func: The function to run. This must be fast and non-blocking.
886886
* @info: An arbitrary pointer to pass to the function.
887-
* @wait: Bitmask that controls the operation. If %SCF_WAIT is set, wait
888-
* (atomically) until function has completed on other CPUs. If
889-
* %SCF_RUN_LOCAL is set, the function will also be run locally
890-
* if the local CPU is set in the @cpumask.
891-
*
892-
* If @wait is true, then returns once @func has returned.
887+
* @wait: If true, wait (atomically) until function has completed
888+
* on other CPUs.
893889
*
894890
* You must not call this function with disabled interrupts or from a
895891
* hardware interrupt handler or from a bottom half handler. Preemption
896892
* must be disabled when calling this function.
893+
*
894+
* @func is not called on the local CPU even if @mask contains it. Consider
895+
* using on_each_cpu_cond_mask() instead if this is not desirable.
897896
*/
898897
void smp_call_function_many(const struct cpumask *mask,
899898
smp_call_func_t func, void *info, bool wait)

0 commit comments

Comments
 (0)