Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make Rustdoc exit with correct error code when scraping examples from invalid files #99976

Merged
merged 1 commit into from
Aug 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/librustdoc/scrape_examples.rs
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,12 @@ pub(crate) fn run(
let mut finder = FindCalls { calls: &mut calls, tcx, map: tcx.hir(), cx, target_crates };
tcx.hir().visit_all_item_likes_in_crate(&mut finder);

// The visitor might have found a type error, which we need to
// promote to a fatal error
if tcx.sess.diagnostic().has_errors_or_lint_errors().is_some() {
return Err(String::from("Compilation failed, aborting rustdoc"));
}

// Sort call locations within a given file in document order
for fn_calls in calls.values_mut() {
for file_calls in fn_calls.values_mut() {
Expand Down
7 changes: 7 additions & 0 deletions src/test/rustdoc-ui/scrape-examples-fail-if-type-error.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// check-fail
// compile-flags: -Z unstable-options --scrape-examples-output-path {{build-base}}/t.calls --scrape-examples-target-crate foobar

pub fn foo() {
INVALID_FUNC();
//~^ ERROR could not resolve path
}
14 changes: 14 additions & 0 deletions src/test/rustdoc-ui/scrape-examples-fail-if-type-error.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
error[E0433]: failed to resolve: could not resolve path `INVALID_FUNC`
--> $DIR/scrape-examples-fail-if-type-error.rs:5:3
|
LL | INVALID_FUNC();
| ^^^^^^^^^^^^ could not resolve path `INVALID_FUNC`
|
= note: this error was originally ignored because you are running `rustdoc`
= note: try running again with `rustc` or `cargo check` and you may get a more detailed error
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol so that's where this error will show up in practice, I mostly just added it for completeness

yeah this seems ok; it points to the right place and gives you an idea of what's going wrong. The only thing to improve is that rustdoc doesn't need to tell the resolver to ignore errors in the first place when scraping examples, but that will be kind of annoying to fix for very marginal benefit.


error: Compilation failed, aborting rustdoc

error: aborting due to 2 previous errors

For more information about this error, try `rustc --explain E0433`.