about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJacob Pratt <jacob@jhpratt.dev>2024-12-17 05:37:30 -0500
committerGitHub <noreply@github.com>2024-12-17 05:37:30 -0500
commit1af7df57694022b30eb9d0ed4a0bbde56a13d39e (patch)
tree531a43cb2c4dc783ad4699e492101d70520fa668
parent3d0e5e024a15f4e288171ad791f1ed19368c0414 (diff)
parent7dbfe4d4cf3c95d2d3cdbdae61b7888dcda0bdf6 (diff)
downloadrust-1af7df57694022b30eb9d0ed4a0bbde56a13d39e.tar.gz
rust-1af7df57694022b30eb9d0ed4a0bbde56a13d39e.zip
Rollup merge of #134409 - RalfJung:bootstrap-comment, r=jieyouxu
bootstrap: fix a comment

I don't actually know if this is right, though...  but "a single call to `paths` will only ever generate a single call to `paths`" just does not make sense.
-rw-r--r--src/bootstrap/src/core/builder/mod.rs6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/bootstrap/src/core/builder/mod.rs b/src/bootstrap/src/core/builder/mod.rs
index 026c26479d3..98f765dbd0f 100644
--- 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])
     }
@@ -622,7 +624,7 @@ impl<'a> ShouldRun<'a> {
     ///
     /// This differs from [`path`] in that multiple calls to path will end up calling `make_run`
     /// multiple times, whereas a single call to `paths` will only ever generate a single call to
-    /// `paths`.
+    /// `make_run`.
     ///
     /// This is analogous to `all_krates`, although `all_krates` is gone now. Prefer [`path`] where possible.
     ///