compiletest: clarify COMPILETEST_NEEDS_ALL_LLVM_COMPONENTS error

RalfJung · RalfJung · commit 4ce7e094ae9d · 2024-05-30T08:07:56.000+02:00
also improve wording for an ignore reason
diff --git a/src/ci/run.sh b/src/ci/run.sh
@@ -90,7 +90,7 @@ RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --dist-compression-formats=xz"
 if [ "$EXTERNAL_LLVM" = "" ]; then
   RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --set build.optimized-compiler-builtins"
   # Likewise, only demand we test all LLVM components if we know we built LLVM with them
-  export COMPILETEST_NEEDS_ALL_LLVM_COMPONENTS=1
+  export COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS=1
 elif [ "$DEPLOY$DEPLOY_ALT" = "1" ]; then
     echo "error: dist builds should always use optimized compiler-rt!" >&2
     exit 1
diff --git a/src/tools/compiletest/src/header.rs b/src/tools/compiletest/src/header.rs
@@ -1436,7 +1436,7 @@ pub fn make_test_description<R: Read>(
             if config.target == "wasm32-unknown-unknown" {
                 if config.parse_name_directive(ln, directives::CHECK_RUN_RESULTS) {
                     decision!(IgnoreDecision::Ignore {
-                        reason: "ignored when checking the run results on WASM".into(),
+                        reason: "ignored on WASM as the run results cannot be checked there".into(),
                     });
                 }
             }
@@ -1577,8 +1577,11 @@ fn ignore_llvm(config: &Config, line: &str) -> IgnoreDecision {
             .split_whitespace()
             .find(|needed_component| !components.contains(needed_component))
         {
-            if env::var_os("COMPILETEST_NEEDS_ALL_LLVM_COMPONENTS").is_some() {
-                panic!("missing LLVM component: {}", missing_component);
+            if env::var_os("COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS").is_some() {
+                panic!(
+                    "missing LLVM component {}, and COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS is set",
+                    missing_component
+                );
             }
             return IgnoreDecision::Ignore {
                 reason: format!("ignored when the {missing_component} LLVM component is missing"),
diff --git a/src/tools/tidy/src/target_specific_tests.rs b/src/tools/tidy/src/target_specific_tests.rs
@@ -90,6 +90,9 @@ pub fn check(path: &Path, bad: &mut bool) {
             }
             if let Some(llvm_components) = llvm_components {
                 for component in llvm_components {
+                    // Ensure the given component even exists.
+                    // This is somewhat redundant with COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS,
+                    // but helps detect such problems earlier (PR CI rather than bors CI).
                     if !KNOWN_LLVM_COMPONENTS.contains(component) {
                         eprintln!(
                             "{}: revision {} specifies unknown LLVM component `{}`",

Original file line number	Diff line number	Diff line change
`@@ -1436,7 +1436,7 @@ pub fn make_test_description<R: Read>(`
`1436`	`1436`	`if config.target == "wasm32-unknown-unknown" {`
`1437`	`1437`	`if config.parse_name_directive(ln, directives::CHECK_RUN_RESULTS) {`
`1438`	`1438`	`decision!(IgnoreDecision::Ignore {`
`1439`		`- reason: "ignored when checking the run results on WASM".into(),`
	`1439`	`+ reason: "ignored on WASM as the run results cannot be checked there".into(),`
`1440`	`1440`	`});`
`1441`	`1441`	`}`
`1442`	`1442`	`}`
`@@ -1577,8 +1577,11 @@ fn ignore_llvm(config: &Config, line: &str) -> IgnoreDecision {`
`1577`	`1577`	`.split_whitespace()`
`1578`	`1578`	`.find(\|needed_component\| !components.contains(needed_component))`
`1579`	`1579`	`{`
`1580`		`- if env::var_os("COMPILETEST_NEEDS_ALL_LLVM_COMPONENTS").is_some() {`
`1581`		`- panic!("missing LLVM component: {}", missing_component);`
	`1580`	`+ if env::var_os("COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS").is_some() {`
	`1581`	`+ panic!(`
	`1582`	`+ "missing LLVM component {}, and COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS is set",`
	`1583`	`+ missing_component`
	`1584`	`+ );`
`1582`	`1585`	`}`
`1583`	`1586`	`return IgnoreDecision::Ignore {`
`1584`	`1587`	`reason: format!("ignored when the {missing_component} LLVM component is missing"),`