-
Notifications
You must be signed in to change notification settings - Fork 14k
[rustdoc] Gracefully handle error in case we cannot run the compiler in doctests #147912
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
Merged
bors
merged 3 commits into
rust-lang:master
from
GuillaumeGomez:graceful-doctest-error-handling
Nov 6, 2025
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| //! ``` | ||
| //! let x = 12; | ||
| //! ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| // This test ensures that if the rustdoc test binary is not executable, it will | ||
| // gracefully fail and not panic. | ||
|
|
||
| //@ needs-target-std | ||
|
|
||
| use run_make_support::{path, rfs, rustdoc}; | ||
|
|
||
| fn main() { | ||
| let absolute_path = path("foo.rs").canonicalize().expect("failed to get absolute path"); | ||
| let output = rustdoc() | ||
| .input("foo.rs") | ||
| .arg("--test") | ||
| .arg("-Zunstable-options") | ||
| .arg("--test-builder") | ||
| .arg(&absolute_path) | ||
| .run_fail(); | ||
|
|
||
| // We check that rustdoc outputs the error correctly... | ||
| output.assert_stdout_contains("Failed to spawn "); | ||
| // ... and that we didn't panic. | ||
| output.assert_not_ice(); | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets also assert that the exit code is 1 (ICE gives 101, like other panics), seems more robust than string comparisons.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
panic!isn't always 101 as exit code (depends on the target). So we can't really check for that. ^^'Discovered that while reading https://github.com/rust-lang/rust/blob/master/library/test/src/test_result.rs#L107.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean, you can just stick it behind a
cfg(unix)or something, it would still me more reliable than only looking at the strings.Is normal error exit always
1? Because that's what I was reccomending we actually put in the assertion.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this case should be enough.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hum, when we fail doctests, we exit with
101. ^^'