Commit ccf09357 authored by Rafael J. Wysocki's avatar Rafael J. Wysocki Committed by Thomas Gleixner
Browse files

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: 49b3bd21 ("smp: Fix all kernel-doc warnings")
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
parent 8f5ae30d

kernel/smp.c

+5 −6
Original line number Diff line number Diff line
@@ -884,16 +884,15 @@ static void smp_call_function_many_cond(const struct cpumask *mask, 
 * @mask: The set of cpus to run on (only runs on online subset).

 * @func: The function to run. This must be fast and non-blocking.

 * @info: An arbitrary pointer to pass to the function.

 * @wait: Bitmask that controls the operation. If %SCF_WAIT is set, wait

 *        (atomically) until function has completed on other CPUs. If

 *        %SCF_RUN_LOCAL is set, the function will also be run locally

 *        if the local CPU is set in the @cpumask.

 *

 * If @wait is true, then returns once @func has returned.

 * @wait: If true, wait (atomically) until function has completed

 *        on other CPUs.

 *

 * You must not call this function with disabled interrupts or from a

 * hardware interrupt handler or from a bottom half handler. Preemption

 * must be disabled when calling this function.

 *

 * @func is not called on the local CPU even if @mask contains it.  Consider

 * using on_each_cpu_cond_mask() instead if this is not desirable.

 */

void smp_call_function_many(const struct cpumask *mask,

			    smp_call_func_t func, void *info, bool wait)