From 44e69f592f4e80a39abe98db5279e03e00c73cef Mon Sep 17 00:00:00 2001
From: ywxt <ywxtcwh@gmail.com>
Date: Thu, 26 Jun 2025 12:30:38 +0800
Subject: [PATCH] Add a comment for the `wait_for_jobs` function.

Co-authored-by: Zoxc <zoxc32@gmail.com>
---
 compiler/rustc_thread_pool/src/registry.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/compiler/rustc_thread_pool/src/registry.rs b/compiler/rustc_thread_pool/src/registry.rs
index 5e2f2e7f1b76..ccf4561014f2 100644
--- a/compiler/rustc_thread_pool/src/registry.rs
+++ b/compiler/rustc_thread_pool/src/registry.rs
@@ -800,6 +800,8 @@ impl WorkerThread {
         unsafe { self.wait_or_steal_until(latch, false) };
     }
 
+    // Wait until the latch is set. Executes local jobs if `is_job` is true for them and
+    // `all_jobs_started` still returns false.
     #[inline]
     pub(super) unsafe fn wait_for_jobs<L: AsCoreLatch + ?Sized, const BROADCAST_JOBS: bool>(
         &self,