Skip to contentSkip to conversation

sched: topology: cleanup comments

PATCH Superseded Yury Norov 2 participants 3 messages Apr 1 – Apr 23 Scheduler

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Yury Norov

author
#0 lore raw

PATCH 1/1 sched: topology: cleanup comments

sched_numa_find_closest() top comment is almost kernel-doc formatted, but doesn't appear to be a valid kernel-doc. Fix that, and while there reword NUMA-level comment, highlighting that 'NUMA level' is a synonym to the number of hops.

---
 kernel/sched/topology.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
kernel/sched/topology.c +5 -5
index 43150591914b..1e7b89ad6d11 100644
@@ -841,7 +841,7 @@ int group_balance_cpu(struct sched_group *sg)
  *
  * We want to construct domains and groups to represent this. The way we go
  * about doing this is to build the domains on 'hops'. For each NUMA level we
- * construct the mask of all nodes reachable in @level hops.
+ * construct the mask of all nodes reachable at that number of hops.
  *
  * For the above NUMA topology that gives 3 levels:
  *
@@ -2237,13 +2237,13 @@ void sched_domains_numa_masks_clear(unsigned int cpu)
 	}
 }
 
-/*
+/**
  * sched_numa_find_closest() - given the NUMA topology, find the cpu
  *                             closest to @cpu from @cpumask.
- * cpumask: cpumask to find a cpu from
- * cpu: cpu to be close to
+ * @cpus: cpumask to find a cpu from
+ * @cpu: cpu to be close to
  *
- * returns: cpu, or nr_cpu_ids when nothing found.
+ * Return: @cpu, or nr_cpu_ids when nothing found.
  */
 int sched_numa_find_closest(const struct cpumask *cpus, int cpu)
 {
Signature · 1 line
2.43.0
author
#1 lore raw

Ping?

Quoted 43 lines · Yury Norov

sched_numa_find_closest() top comment is almost kernel-doc formatted, but doesn't appear to be a valid kernel-doc. Fix that, and while there reword NUMA-level comment, highlighting that 'NUMA level' is a synonym to the number of hops.

---
 kernel/sched/topology.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
kernel/sched/topology.c +5 -5
index 43150591914b..1e7b89ad6d11 100644
@@ -841,7 +841,7 @@ int group_balance_cpu(struct sched_group *sg)
  *
  * We want to construct domains and groups to represent this. The way we go
  * about doing this is to build the domains on 'hops'. For each NUMA level we
- * construct the mask of all nodes reachable in @level hops.
+ * construct the mask of all nodes reachable at that number of hops.
  *
  * For the above NUMA topology that gives 3 levels:
  *
@@ -2237,13 +2237,13 @@ void sched_domains_numa_masks_clear(unsigned int cpu)
 	}
 }
 
-/*
+/**
  * sched_numa_find_closest() - given the NUMA topology, find the cpu
  *                             closest to @cpu from @cpumask.
- * cpumask: cpumask to find a cpu from
- * cpu: cpu to be close to
+ * @cpus: cpumask to find a cpu from
+ * @cpu: cpu to be close to
  *
- * returns: cpu, or nr_cpu_ids when nothing found.
+ * Return: @cpu, or nr_cpu_ids when nothing found.
  */
 int sched_numa_find_closest(const struct cpumask *cpus, int cpu)
 {
Signature · 1 line
2.43.0
#2 lore raw
In reply to Yury Norov
Quoted 28 lines · Yury Norov

sched_numa_find_closest() top comment is almost kernel-doc formatted, but doesn't appear to be a valid kernel-doc. Fix that, and while there reword NUMA-level comment, highlighting that 'NUMA level' is a synonym to the number of hops.

---
 kernel/sched/topology.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
kernel/sched/topology.c +1 -2
index 43150591914b..1e7b89ad6d11 100644
@@ -841,7 +841,7 @@ int group_balance_cpu(struct sched_group *sg)
  *
  * We want to construct domains and groups to represent this. The way we go
  * about doing this is to build the domains on 'hops'. For each NUMA level we
- * construct the mask of all nodes reachable in @level hops.
+ * construct the mask of all nodes reachable at that number of hops.
  *
  * For the above NUMA topology that gives 3 levels:
  *
@@ -2237,13 +2237,13 @@ void sched_domains_numa_masks_clear(unsigned int cpu)
      }
 }
 
-/*

kernel/sched/topology.c void sched_domains_numa_masks_clear(unsigned int cpu) · line 2246

Quoted 10 lines
kernel/sched/topology.c +4 -3
+/**
  * sched_numa_find_closest() - given the NUMA topology, find the cpu
  *                             closest to @cpu from @cpumask.
- * cpumask: cpumask to find a cpu from
- * cpu: cpu to be close to
+ * @cpus: cpumask to find a cpu from
+ * @cpu: cpu to be close to
  *
- * returns: cpu, or nr_cpu_ids when nothing found.
+ * Return: @cpu, or nr_cpu_ids when nothing found.

The return isn't the input @cpu, so that's not right. Something more like so?

Return: closest CPU number, or nr_cpu_ids when nothing found

Quoted 5 lines
kernel/sched/topology.c +0 -1
  */
 int sched_numa_find_closest(const struct cpumask *cpus, int cpu)
 {
--

2.43.0