Fix bug in `rustdoc -Whelp` #98799

jyn514 · 2022-07-02T05:55:46Z

Previously, this printed the debugging options, not the lint options,
and only handled -Whelp, not -A/-D/-F.

This also fixes a few other misc issues:

Fix // check-stdout for UI tests; previously it only worked for run-fail and compile-fail tests
Add lint headers for tool lints, not just builtin lints

jyn514 · 2022-07-02T05:56:28Z

src/tools/compiletest/src/runtest.rs

@@ -3245,7 +3246,7 @@ impl<'test> TestCx<'test> {

            if !self.props.error_patterns.is_empty() {
                // "// error-pattern" comments
-                self.check_error_patterns(&proc_res.stderr, &proc_res, pm);
+                self.check_error_patterns(&output_to_check, &proc_res, pm);


before, // check-stdout was broken and did nothing for UI tests

jyn514 · 2022-07-02T06:24:33Z

src/librustdoc/lib.rs

+            let mut lint_store = rustc_lint::new_lint_store(
+                sess.opts.debugging_opts.no_interleave_lints,
+                sess.unstable_options(),
+            );
+            let registered_lints = if let Some(register_lints) = compiler.register_lints() {
+                register_lints(sess, &mut lint_store);
+                true
+            } else {
+                false
+            };


this can't just be register_plugins() because that ends up trying to parse the source file, which fails because it's an empty string. this code is taken from

rust/compiler/rustc_driver/src/lib.rs

Lines 249 to 263 in e1b6f16

if sopts.describe_lints {

let mut lint_store = rustc_lint::new_lint_store(

sopts.debugging_opts.no_interleave_lints,

compiler.session().unstable_options(),

);

let registered_lints =

if let Some(register_lints) = compiler.register_lints() {

register_lints(compiler.session(), &mut lint_store);

true

} else {

false

};

describe_lints(compiler.session(), &lint_store, registered_lints);

return;

}

jyn514 · 2022-07-02T06:25:14Z

src/test/rustdoc-ui/issue-83883-describe-lints.stdout

+
+Lint checks provided by plugins loaded by this crate:
+
+    $NAMES  $LEVELS  $MEANINGS


this ended up fixing my original complaint in #98533 (comment) :)

Previously, this printed the debugging options, not the lint options, and only handled `-Whelp`, not `-A/-D/-F`. This also fixes a few other misc issues: - Fix `// check-stdout` for UI tests; previously it only worked for run-fail and compile-fail tests - Add lint headers for tool lints, not just builtin lints - Remove duplicate run-make test

GuillaumeGomez · 2022-07-02T09:37:48Z

Just to be sure: there are other UI tests that check the output you removed?

jyn514 · 2022-07-02T15:46:36Z

Yes, you can see them in the diff: src/test/rustdoc-ui/issue-83883-describe-lints.rs
The run-make test did the same thing and couldn't be blessed, so it would have to be manually updated on each new lint.

GuillaumeGomez · 2022-07-03T18:06:41Z

Thanks!

@bors r+ rollup

bors · 2022-07-03T18:06:43Z

📌 Commit 17da4e0 has been approved by GuillaumeGomez

…meGomez Fix bug in `rustdoc -Whelp` Previously, this printed the debugging options, not the lint options, and only handled `-Whelp`, not `-A/-D/-F`. This also fixes a few other misc issues: - Fix `// check-stdout` for UI tests; previously it only worked for run-fail and compile-fail tests - Add lint headers for tool lints, not just builtin lints rust-lang#98533 (comment) r? `@GuillaumeGomez`

…meGomez Fix bug in `rustdoc -Whelp` Previously, this printed the debugging options, not the lint options, and only handled `-Whelp`, not `-A/-D/-F`. This also fixes a few other misc issues: - Fix `// check-stdout` for UI tests; previously it only worked for run-fail and compile-fail tests - Add lint headers for tool lints, not just builtin lints rust-lang#98533 (comment) r? ``@GuillaumeGomez``

Rollup of 4 pull requests Successful merges: - rust-lang#94831 (Link to stabilization section in std-dev-guide for library tracking issue template) - rust-lang#98764 (add Miri to the nightly docs) - rust-lang#98773 (rustdoc: use <details> tag for the source code sidebar) - rust-lang#98799 (Fix bug in `rustdoc -Whelp`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-lints Area: Lints (warnings about flaws in source code) such as unused_mut. labels Jul 2, 2022

rust-highfive assigned GuillaumeGomez Jul 2, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 2, 2022

jyn514 commented Jul 2, 2022

View reviewed changes

This comment has been minimized.

# to view

jyn514 force-pushed the rustdoc-lint-help branch 2 times, most recently from 564518d to fa39bd4 Compare July 2, 2022 06:23

jyn514 commented Jul 2, 2022

View reviewed changes

jyn514 force-pushed the rustdoc-lint-help branch from fa39bd4 to 56b512b Compare July 2, 2022 06:35

jyn514 force-pushed the rustdoc-lint-help branch from 56b512b to 17da4e0 Compare July 2, 2022 07:12

GuillaumeGomez approved these changes Jul 3, 2022

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 3, 2022

matthiaskrgr mentioned this pull request Jul 3, 2022

Rollup of 5 pull requests #98858

Closed

This was referenced Jul 3, 2022

Rollup of 4 pull requests #98859

Closed

Rollup of 4 pull requests #98864

Merged

bors merged commit ce76d73 into rust-lang:master Jul 4, 2022

rustbot added this to the 1.64.0 milestone Jul 4, 2022

jyn514 deleted the rustdoc-lint-help branch February 25, 2023 18:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix bug in `rustdoc -Whelp` #98799

Fix bug in `rustdoc -Whelp` #98799

Uh oh!

jyn514 commented Jul 2, 2022 •

edited

Loading

Uh oh!

jyn514 Jul 2, 2022

Uh oh!

This comment has been minimized.

jyn514 Jul 2, 2022 •

edited

Loading

Uh oh!

jyn514 Jul 2, 2022

Uh oh!

GuillaumeGomez commented Jul 2, 2022

Uh oh!

jyn514 commented Jul 2, 2022

Uh oh!

GuillaumeGomez commented Jul 3, 2022

Uh oh!

bors commented Jul 3, 2022

Uh oh!

Uh oh!

	if sopts.describe_lints {
	let mut lint_store = rustc_lint::new_lint_store(
	sopts.debugging_opts.no_interleave_lints,
	compiler.session().unstable_options(),
	);
	let registered_lints =
	if let Some(register_lints) = compiler.register_lints() {
	register_lints(compiler.session(), &mut lint_store);
	true
	} else {
	false
	};
	describe_lints(compiler.session(), &lint_store, registered_lints);
	return;
	}


		Lint checks provided by plugins loaded by this crate:

		$NAMES $LEVELS $MEANINGS

Fix bug in rustdoc -Whelp #98799

Fix bug in rustdoc -Whelp #98799

Uh oh!

Conversation

jyn514 commented Jul 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jyn514 Jul 2, 2022

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

jyn514 Jul 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jyn514 Jul 2, 2022

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Jul 2, 2022

Uh oh!

jyn514 commented Jul 2, 2022

Uh oh!

GuillaumeGomez commented Jul 3, 2022

Uh oh!

bors commented Jul 3, 2022

Uh oh!

Uh oh!

Fix bug in `rustdoc -Whelp` #98799

Fix bug in `rustdoc -Whelp` #98799

jyn514 commented Jul 2, 2022 •

edited

Loading

jyn514 Jul 2, 2022 •

edited

Loading