Update documentation

Signed-off-by: Klimenty Tsoutsman <klim@tsoutsman.com>
theseus-os · Sep 16, 2023 · dfd9fe2 · dfd9fe2
1 parent a9d9fac
commit dfd9fe2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/kernel/task/src/scheduler.rs b/kernel/task/src/scheduler.rs
@@ -100,6 +100,9 @@ where
 }
 
 /// Adds the given task to the least busy run queue.
+///
+/// However, if the task is pinned to a a CPU, this function will respect that,
+/// and only add the task to that CPUs runqueue.
 pub fn add_task(task: TaskRef) {
     if let Some(cpu) = task.pinned_cpu() {
         add_task_to(cpu, task)