From: Yury Norov <yury.norov@gmail.com>
Date: Sat, 19 Aug 2023 14:12:38 +0000 (-0700)
Subject: sched/topology: Fix sched_numa_find_nth_cpu() comment
X-Git-Tag: v6.7-rc1~192^2~69
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6d08ad2166f7770341ea56afad45fa41cd16ae62;p=thirdparty%2Fkernel%2Flinux.git

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
---

diff --git a/kernel/sched/topology.c b/kernel/sched/topology.c
index a60ecf45360cb..a7b50bba7829d 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)
 {