Skip to content

Commit 636b393

Browse files
committed
compiletest: remove pretty-expanded directive and infra
Foreword ======== Let us begin the journey to rediscover what the `//@ pretty-expanded` directive does, brave traveller -- "My good friend, [..] when I wrote that passage, God and I knew what it meant. It is possible that God knows it still; but as for me, I have totally forgotten." -- Johann Paul Friedrich Richter, 1826 We must retrace the steps of those before us, for history shall guide us in the present and inform us of the future. The Past ======== Originally there was some effort to introduce more test coverage for `-Z unpretty=expanded` (in 2015 this was called `--pretty=expanded`). In [Make it an error to not declare used features rust-lang#23598][pr-23598], there was a flip from `//@ no-pretty-expanded` (opt-out of `-Z unpretty=expanded` test) to `//@ pretty-expanded` (opt-in to `-Z unpretty=expanded` test). This was needed because back then the dedicated `tests/pretty` ("pretty") test suite did not existed, and the pretty tests were grouped together under `run-pass` tests (I believe `ui` test suite didn't exist back then either). Unfortunately, in this process the replacement `//@ pretty-expanded` directives contained a `FIXME rust-lang#23616` linking to [There are very few tests for `-Z unpretty` expansion rust-lang#23616][issue-23616]. But this was arguably backwards and somewhat misleading, as noted in <rust-lang#23616 (comment)>: The attribute is off by default and things just work if you don't test it, people have not been adding the `pretty-expanded` annotation to new tests even if it would work. Which basically renders this useless. The Present =========== As of Nov 2024, we have a dedicated `pretty` test suite, and some time over the years the split between `run-pass` into `ui` and `pretty` test suites caused all of the `//@ pretty-expanded` in `ui` tests to do absolutely nothing -- the compiletest logic for `pretty-expanded` only triggered in the *pretty* test suite, but none of the pretty tests use it. Oops. The Future ========== Nobody remembers this, nobody uses this, it's misleading in ui tests. Let's get rid of this directive altogether. [pr-23598]: rust-lang#23598 [issue-23616]: rust-lang#23616
1 parent 7db7489 commit 636b393

File tree

3 files changed

+0
-10
lines changed

3 files changed

+0
-10
lines changed

src/tools/compiletest/src/directive-list.rs

-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,6 @@ const KNOWN_DIRECTIVE_NAMES: &[&str] = &[
214214
"only-x86_64-unknown-linux-gnu",
215215
"pp-exact",
216216
"pretty-compare-only",
217-
"pretty-expanded",
218217
"pretty-mode",
219218
"reference",
220219
"regex-error-pattern",

src/tools/compiletest/src/header.rs

-5
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,6 @@ pub struct TestProps {
124124
// a proc-macro and needs `#![crate_type = "proc-macro"]`. This ensures
125125
// that the aux file is compiled as a `proc-macro` and not as a `dylib`.
126126
pub no_prefer_dynamic: bool,
127-
// Run -Zunpretty expanded when running pretty printing tests
128-
pub pretty_expanded: bool,
129127
// Which pretty mode are we testing with, default to 'normal'
130128
pub pretty_mode: String,
131129
// Only compare pretty output and don't try compiling
@@ -218,7 +216,6 @@ mod directives {
218216
pub const DONT_CHECK_COMPILER_STDOUT: &'static str = "dont-check-compiler-stdout";
219217
pub const DONT_CHECK_COMPILER_STDERR: &'static str = "dont-check-compiler-stderr";
220218
pub const NO_PREFER_DYNAMIC: &'static str = "no-prefer-dynamic";
221-
pub const PRETTY_EXPANDED: &'static str = "pretty-expanded";
222219
pub const PRETTY_MODE: &'static str = "pretty-mode";
223220
pub const PRETTY_COMPARE_ONLY: &'static str = "pretty-compare-only";
224221
pub const AUX_BIN: &'static str = "aux-bin";
@@ -278,7 +275,6 @@ impl TestProps {
278275
dont_check_compiler_stderr: false,
279276
compare_output_lines_by_subset: false,
280277
no_prefer_dynamic: false,
281-
pretty_expanded: false,
282278
pretty_mode: "normal".to_string(),
283279
pretty_compare_only: false,
284280
forbid_output: vec![],
@@ -425,7 +421,6 @@ impl TestProps {
425421
&mut self.dont_check_compiler_stderr,
426422
);
427423
config.set_name_directive(ln, NO_PREFER_DYNAMIC, &mut self.no_prefer_dynamic);
428-
config.set_name_directive(ln, PRETTY_EXPANDED, &mut self.pretty_expanded);
429424

430425
if let Some(m) = config.parse_name_value_directive(ln, PRETTY_MODE) {
431426
self.pretty_mode = m;

src/tools/compiletest/src/runtest/pretty.rs

-4
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,6 @@ impl TestCx<'_> {
8585
self.fatal_proc_rec("pretty-printed source does not typecheck", &proc_res);
8686
}
8787

88-
if !self.props.pretty_expanded {
89-
return;
90-
}
91-
9288
// additionally, run `-Zunpretty=expanded` and try to build it.
9389
let proc_res = self.print_source(ReadFrom::Path, "expanded");
9490
if !proc_res.status.success() {

0 commit comments

Comments
 (0)