clarify that path() is for on-disk paths

rust-lang · Dec 17, 2024 · 7dbfe4d · 7dbfe4d
1 parent 6ace653
commit 7dbfe4d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/bootstrap/src/core/builder/mod.rs b/src/bootstrap/src/core/builder/mod.rs
@@ -613,7 +613,9 @@ impl<'a> ShouldRun<'a> {
         self
     }
 
-    // single, non-aliased path
+    /// single, non-aliased path
+    ///
+    /// Must be an on-disk path; use `alias` for names that do not correspond to on-disk paths.
     pub fn path(self, path: &str) -> Self {
         self.paths(&[path])
     }