Skip to content

Commit 71770d5

Browse files
committed
Document ShouldRun::paths
1 parent 3e765a7 commit 71770d5

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/bootstrap/builder.rs

+9-1
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,15 @@ impl<'a> ShouldRun<'a> {
473473
self.paths(&[path])
474474
}
475475

476-
// multiple aliases for the same job
476+
/// Multiple aliases for the same job.
477+
///
478+
/// This differs from [`path`] in that multiple calls to path will end up calling `make_run`
479+
/// multiple times, whereas a single call to `paths` will only ever generate a single call to
480+
/// `paths`.
481+
///
482+
/// This is analogous to `all_krates`, although `all_krates` is gone now. Prefer [`path`] where possible.
483+
///
484+
/// [`path`]: ShouldRun::path
477485
pub fn paths(mut self, paths: &[&str]) -> Self {
478486
static SUBMODULES_PATHS: OnceCell<Vec<String>> = OnceCell::new();
479487

0 commit comments

Comments
 (0)