summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYury Norov <yury.norov@gmail.com>2023-08-19 07:12:38 -0700
committerIngo Molnar <mingo@kernel.org>2023-09-15 13:48:11 +0200
commit6d08ad2166f7770341ea56afad45fa41cd16ae62 (patch)
tree696dad4d182fe134ffda14a94d22073010897b6a
parent9ecea9ae4d3127a09fb5dfcea87f248937a39ff5 (diff)
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: Yury Norov <yury.norov@gmail.com> Signed-off-by: Ingo Molnar <mingo@kernel.org> Cc: Mel Gorman <mgorman@suse.de> Link: https://lore.kernel.org/r/20230819141239.287290-7-yury.norov@gmail.com
-rw-r--r--kernel/sched/topology.c16
1 files changed, 9 insertions, 7 deletions
diff --git a/kernel/sched/topology.c b/kernel/sched/topology.c
index a60ecf45360c..a7b50bba7829 100644
--- a/kernel/sched/topology.c
+++ b/kernel/sched/topology.c
@@ -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)
{