improve check::{Std, Rustc} to handle clippy properly

Signed-off-by: onur-ozkan <[email protected]>
rust-lang · Jul 27, 2024 · 4b87b59 · 4b87b59
1 parent d94e7ff
commit 4b87b59
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 8 deletions.
diff --git a/src/bootstrap/src/core/build_steps/check.rs b/src/bootstrap/src/core/build_steps/check.rs
@@ -20,11 +20,22 @@ pub struct Std {
     ///
     /// [`compile::Rustc`]: crate::core::build_steps::compile::Rustc
     crates: Vec<String>,
+    /// Whether to force `Kind::Check` on cargo invocations.
+    ///
+    /// By default, `Builder::kind` is propagated to the cargo invocations. However, there are cases
+    /// when this is not desirable. For example, when running `x clippy $tool_name`, passing `Builder::kind`
+    /// to cargo invocations would run clippy on the entire compiler and library, which is not useful if
+    /// we only want to lint a few crates with specific rules.
+    force_check: bool,
 }
 
 impl Std {
     pub fn new(target: TargetSelection) -> Self {
-        Self { target, crates: vec![] }
+        Self { target, crates: vec![], force_check: false }
+    }
+
+    pub fn new_with_force_check_flag(target: TargetSelection, force_check: bool) -> Self {
+        Self { target, crates: vec![], force_check }
     }
 }
 
@@ -38,7 +49,7 @@ impl Step for Std {
 
     fn make_run(run: RunConfig<'_>) {
         let crates = run.make_run_crates(Alias::Library);
-        run.builder.ensure(Std { target: run.target, crates });
+        run.builder.ensure(Std { target: run.target, crates, force_check: false });
     }
 
     fn run(self, builder: &Builder<'_>) {
@@ -53,7 +64,7 @@ impl Step for Std {
             Mode::Std,
             SourceType::InTree,
             target,
-            builder.kind,
+            if self.force_check { Kind::Check } else { builder.kind },
         );
 
         std_cargo(builder, target, compiler.stage, &mut cargo);
@@ -148,6 +159,13 @@ pub struct Rustc {
     ///
     /// [`compile::Rustc`]: crate::core::build_steps::compile::Rustc
     crates: Vec<String>,
+    /// Whether to force `Kind::Check` on cargo invocations.
+    ///
+    /// By default, `Builder::kind` is propagated to the cargo invocations. However, there are cases
+    /// when this is not desirable. For example, when running `x clippy $tool_name`, passing `Builder::kind`
+    /// to cargo invocations would run clippy on the entire compiler and library, which is not useful if
+    /// we only want to lint a few crates with specific rules.
+    force_check: bool,
 }
 
 impl Rustc {
@@ -157,7 +175,20 @@ impl Rustc {
             .into_iter()
             .map(|krate| krate.name.to_string())
             .collect();
-        Self { target, crates }
+        Self { target, crates, force_check: false }
+    }
+
+    pub fn new_with_force_check_flag(
+        target: TargetSelection,
+        builder: &Builder<'_>,
+        force_check: bool,
+    ) -> Self {
+        let crates = builder
+            .in_tree_crates("rustc-main", Some(target))
+            .into_iter()
+            .map(|krate| krate.name.to_string())
+            .collect();
+        Self { target, crates, force_check }
     }
 }
 
@@ -172,7 +203,7 @@ impl Step for Rustc {
 
     fn make_run(run: RunConfig<'_>) {
         let crates = run.make_run_crates(Alias::Compiler);
-        run.builder.ensure(Rustc { target: run.target, crates });
+        run.builder.ensure(Rustc { target: run.target, crates, force_check: false });
     }
 
     /// Builds the compiler.
@@ -193,7 +224,7 @@ impl Step for Rustc {
             builder.ensure(crate::core::build_steps::compile::Std::new(compiler, compiler.host));
             builder.ensure(crate::core::build_steps::compile::Std::new(compiler, target));
         } else {
-            builder.ensure(Std::new(target));
+            builder.ensure(Std::new_with_force_check_flag(target, self.force_check));
         }
 
         let mut cargo = builder::Cargo::new(
@@ -202,7 +233,7 @@ impl Step for Rustc {
             Mode::Rustc,
             SourceType::InTree,
             target,
-            builder.kind,
+            if self.force_check { Kind::Check } else { builder.kind },
         );
 
         rustc_cargo(builder, &mut cargo, target, &compiler);

diff --git a/src/bootstrap/src/core/build_steps/clippy.rs b/src/bootstrap/src/core/build_steps/clippy.rs
@@ -267,7 +267,7 @@ macro_rules! lint_any {
                 let compiler = builder.compiler(builder.top_stage, builder.config.build);
                 let target = self.target;
 
-                builder.ensure(check::Rustc::new(target, builder));
+                builder.ensure(check::Rustc::new_with_force_check_flag(target, builder, true));
 
                 let cargo = prepare_tool_cargo(
                     builder,