Auto merge of #148305 - RalfJung:add-minicore, r=jieyouxu,wesleywiser

compiletest: rename `add-core-stubs`/`core-stubs-compile-flags` to `add-minicore`/`minicore-compile-flags`

Fixes #148282

Author: bors

src/doc/rustc-dev-guide/src/tests/minicore.md

@@ -14,21 +14,21 @@ range of tests.
 
 </div>
 
-A test can use [`minicore`] by specifying the `//@ add-core-stubs` directive.
-Then, mark the test with `#![feature(no_core)]` + `#![no_std]` + `#![no_core]`.
-Due to Edition 2015 extern prelude rules, you will probably need to declare
-`minicore` as an extern crate.
+A test can use [`minicore`] by specifying the `//@ add-minicore` directive.
+Then, mark the test with `#![feature(no_core)]` + `#![no_std]` + `#![no_core]`,
+and import the crate into the test with `extern crate minicore` (edition 2015)
+or `use minicore` (edition 2018+).
 
 ## Implied compiler flags
 
-Due to the `no_std` + `no_core` nature of these tests, `//@ add-core-stubs`
+Due to the `no_std` + `no_core` nature of these tests, `//@ add-minicore`
 implies and requires that the test will be built with `-C panic=abort`.
 **Unwinding panics are not supported.**
 
 Tests will also be built with `-C force-unwind-tables=yes` to preserve CFI
 directives in assembly tests.
 
-TL;DR: `//@ add-core-stubs` implies two compiler flags:
+TL;DR: `//@ add-minicore` implies two compiler flags:
 
 1. `-C panic=abort`
 2. `-C force-unwind-tables=yes`
@@ -48,7 +48,7 @@ attributes (e.g. `on_unimplemented`) should be replicated exactly in `minicore`.
 ## Example codegen test that uses `minicore`
 
 ```rust,no_run
-//@ add-core-stubs
+//@ add-minicore
 //@ revisions: meow bark
 //@[meow] compile-flags: --target=x86_64-unknown-linux-gnu
 //@[meow] needs-llvm-components: x86

src/tools/compiletest/src/directives.rs

@@ -200,9 +200,9 @@ pub(crate) struct TestProps {
     pub no_auto_check_cfg: bool,
     /// Build and use `minicore` as `core` stub for `no_core` tests in cross-compilation scenarios
     /// that don't otherwise want/need `-Z build-std`.
-    pub add_core_stubs: bool,
+    pub add_minicore: bool,
     /// Add these flags to the build of `minicore`.
-    pub core_stubs_compile_flags: Vec<String>,
+    pub minicore_compile_flags: Vec<String>,
     /// Whether line annotatins are required for the given error kind.
     pub dont_require_annotations: HashSet<ErrorKind>,
     /// Whether pretty printers should be disabled in gdb.
@@ -254,8 +254,8 @@ mod directives {
     pub const LLVM_COV_FLAGS: &'static str = "llvm-cov-flags";
     pub const FILECHECK_FLAGS: &'static str = "filecheck-flags";
     pub const NO_AUTO_CHECK_CFG: &'static str = "no-auto-check-cfg";
-    pub const ADD_CORE_STUBS: &'static str = "add-core-stubs";
-    pub const CORE_STUBS_COMPILE_FLAGS: &'static str = "core-stubs-compile-flags";
+    pub const ADD_MINICORE: &'static str = "add-minicore";
+    pub const MINICORE_COMPILE_FLAGS: &'static str = "minicore-compile-flags";
     pub const DISABLE_GDB_PRETTY_PRINTERS: &'static str = "disable-gdb-pretty-printers";
     pub const COMPARE_OUTPUT_BY_LINES: &'static str = "compare-output-by-lines";
 }
@@ -311,8 +311,8 @@ impl TestProps {
             llvm_cov_flags: vec![],
             filecheck_flags: vec![],
             no_auto_check_cfg: false,
-            add_core_stubs: false,
-            core_stubs_compile_flags: vec![],
+            add_minicore: false,
+            minicore_compile_flags: vec![],
             dont_require_annotations: Default::default(),
             disable_gdb_pretty_printers: false,
             compare_output_by_lines: false,
@@ -601,18 +601,18 @@ impl TestProps {
 
                     config.set_name_directive(ln, NO_AUTO_CHECK_CFG, &mut self.no_auto_check_cfg);
 
-                    self.update_add_core_stubs(ln, config);
+                    self.update_add_minicore(ln, config);
 
                     if let Some(flags) =
-                        config.parse_name_value_directive(ln, CORE_STUBS_COMPILE_FLAGS)
+                        config.parse_name_value_directive(ln, MINICORE_COMPILE_FLAGS)
                     {
                         let flags = split_flags(&flags);
                         for flag in &flags {
                             if flag == "--edition" || flag.starts_with("--edition=") {
                                 panic!("you must use `//@ edition` to configure the edition");
                             }
                         }
-                        self.core_stubs_compile_flags.extend(flags);
+                        self.minicore_compile_flags.extend(flags);
                     }
 
                     if let Some(err_kind) =
@@ -753,12 +753,12 @@ impl TestProps {
         self.pass_mode
     }
 
-    fn update_add_core_stubs(&mut self, ln: &DirectiveLine<'_>, config: &Config) {
-        let add_core_stubs = config.parse_name_directive(ln, directives::ADD_CORE_STUBS);
-        if add_core_stubs {
+    fn update_add_minicore(&mut self, ln: &DirectiveLine<'_>, config: &Config) {
+        let add_minicore = config.parse_name_directive(ln, directives::ADD_MINICORE);
+        if add_minicore {
             if !matches!(config.mode, TestMode::Ui | TestMode::Codegen | TestMode::Assembly) {
                 panic!(
-                    "`add-core-stubs` is currently only supported for ui, codegen and assembly test modes"
+                    "`add-minicore` is currently only supported for ui, codegen and assembly test modes"
                 );
             }
 
@@ -767,10 +767,10 @@ impl TestProps {
             if self.local_pass_mode().is_some_and(|pm| pm == PassMode::Run) {
                 // `minicore` can only be used with non-run modes, because it's `core` prelude stubs
                 // and can't run.
-                panic!("`add-core-stubs` cannot be used to run the test binary");
+                panic!("`add-minicore` cannot be used to run the test binary");
             }
 
-            self.add_core_stubs = add_core_stubs;
+            self.add_minicore = add_minicore;
         }
     }
 }

src/tools/compiletest/src/directives/directive_names.rs

@@ -3,7 +3,7 @@
 /// a best-effort approximation for diagnostics. Add new directives to this list when needed.
 pub(crate) const KNOWN_DIRECTIVE_NAMES: &[&str] = &[
     // tidy-alphabetical-start
-    "add-core-stubs",
+    "add-minicore",
     "assembly-output",
     "aux-bin",
     "aux-build",
@@ -19,7 +19,6 @@ pub(crate) const KNOWN_DIRECTIVE_NAMES: &[&str] = &[
     "check-test-line-numbers-match",
     "compare-output-by-lines",
     "compile-flags",
-    "core-stubs-compile-flags",
     "disable-gdb-pretty-printers",
     "doc-flags",
     "dont-check-compiler-stderr",
@@ -141,6 +140,7 @@ pub(crate) const KNOWN_DIRECTIVE_NAMES: &[&str] = &[
     "min-lldb-version",
     "min-llvm-version",
     "min-system-llvm-version",
+    "minicore-compile-flags",
     "needs-asm-support",
     "needs-backends",
     "needs-crate-type",

src/tools/compiletest/src/runtest.rs

@@ -1307,7 +1307,7 @@ impl<'test> TestCx<'test> {
     /// `root_testpaths` refers to the path of the original test. the auxiliary and the test with an
     /// aux-build have the same `root_testpaths`.
     fn compose_and_run_compiler(&self, mut rustc: Command, input: Option<String>) -> ProcRes {
-        if self.props.add_core_stubs {
+        if self.props.add_minicore {
             let minicore_path = self.build_minicore();
             rustc.arg("--extern");
             rustc.arg(&format!("minicore={}", minicore_path));
@@ -1341,7 +1341,7 @@ impl<'test> TestCx<'test> {
 
         rustc.args(&["--crate-type", "rlib"]);
         rustc.arg("-Cpanic=abort");
-        rustc.args(self.props.core_stubs_compile_flags.clone());
+        rustc.args(self.props.minicore_compile_flags.clone());
 
         let res = self.compose_and_run(rustc, self.config.compile_lib_path.as_path(), None, None);
         if !res.status.success() {
@@ -1449,7 +1449,7 @@ impl<'test> TestCx<'test> {
 
         aux_rustc.arg("-L").arg(&aux_dir);
 
-        if aux_props.add_core_stubs {
+        if aux_props.add_minicore {
             let minicore_path = self.build_minicore();
             aux_rustc.arg("--extern");
             aux_rustc.arg(&format!("minicore={}", minicore_path));
@@ -1891,7 +1891,7 @@ impl<'test> TestCx<'test> {
         // change the default.
         //
         // `minicore` requires `#![no_std]` and `#![no_core]`, which means no unwinding panics.
-        if self.props.add_core_stubs {
+        if self.props.add_minicore {
             rustc.arg("-Cpanic=abort");
             rustc.arg("-Cforce-unwind-tables=yes");
         }

tests/assembly-llvm/aarch64-pointer-auth.rs

@@ -1,6 +1,6 @@
 // Test that PAC instructions are emitted when branch-protection is specified.
 
-//@ add-core-stubs
+//@ add-minicore
 //@ revisions: GCS PACRET PAUTHLR_NOP PAUTHLR
 //@ assembly-output: emit-asm
 //@ needs-llvm-components: aarch64

tests/assembly-llvm/asm/aarch64-el2vmsa.rs

@@ -1,4 +1,4 @@
-//@ add-core-stubs
+//@ add-minicore
 //@ assembly-output: emit-asm
 //@ compile-flags: --target aarch64-unknown-linux-gnu
 //@ needs-llvm-components: aarch64

tests/assembly-llvm/asm/aarch64-modifiers.rs

@@ -1,4 +1,4 @@
-//@ add-core-stubs
+//@ add-minicore
 //@ assembly-output: emit-asm
 //@ compile-flags: -Copt-level=3 -C panic=abort
 //@ compile-flags: --target aarch64-unknown-linux-gnu

tests/assembly-llvm/asm/aarch64-types.rs

@@ -1,4 +1,4 @@
-//@ add-core-stubs
+//@ add-minicore
 //@ revisions: aarch64 arm64ec
 //@ assembly-output: emit-asm
 //@ [aarch64] compile-flags: --target aarch64-unknown-linux-gnu

tests/assembly-llvm/asm/arm-modifiers.rs

@@ -1,4 +1,4 @@
-//@ add-core-stubs
+//@ add-minicore
 //@ assembly-output: emit-asm
 //@ compile-flags: -Copt-level=3 -C panic=abort
 //@ compile-flags: --target armv7-unknown-linux-gnueabihf

tests/assembly-llvm/asm/arm-types.rs

@@ -1,4 +1,4 @@
-//@ add-core-stubs
+//@ add-minicore
 //@ revisions: base d32 neon
 //@ assembly-output: emit-asm
 //@ compile-flags: --target armv7-unknown-linux-gnueabihf