Commit 6d08ad21 authored by Yury Norov's avatar Yury Norov Committed by Ingo Molnar
Browse files

sched/topology: Fix sched_numa_find_nth_cpu() comment 



Reword sched_numa_find_nth_cpu() comment and make it kernel-doc compatible.

Signed-off-by: default avatarYury Norov <yury.norov@gmail.com>
Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
Cc: Mel Gorman <mgorman@suse.de>
Link: https://lore.kernel.org/r/20230819141239.287290-7-yury.norov@gmail.com
parent 9ecea9ae

kernel/sched/topology.c

+9 −7
Original line number Diff line number Diff line
@@ -2112,13 +2112,15 @@ static int hop_cmp(const void *a, const void *b) 
	return -1;

}



/*

 * sched_numa_find_nth_cpu() - given the NUMA topology, find the Nth next cpu

 *                             closest to @cpu from @cpumask.

 * cpumask: cpumask to find a cpu from

 * cpu: Nth cpu to find

 *

 * returns: cpu, or nr_cpu_ids when nothing found.

/**

 * sched_numa_find_nth_cpu() - given the NUMA topology, find the Nth closest CPU

 *                             from @cpus to @cpu, taking into account distance

 *                             from a given @node.

 * @cpus: cpumask to find a cpu from

 * @cpu: CPU to start searching

 * @node: NUMA node to order CPUs by distance

 *

 * Return: cpu, or nr_cpu_ids when nothing found.

 */

int sched_numa_find_nth_cpu(const struct cpumask *cpus, int cpu, int node)

{