Skip to content

Improve librustdoc error when a file creation/modification failed #146000

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.

Sign up for GitHub

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
merged 1 commit into from
Aug 30, 2025
Merged

Improve librustdoc error when a file creation/modification failed #146000

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion src/librustdoc/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,9 @@ fn run_renderer<
tcx.dcx().struct_fatal(format!("couldn't generate documentation: {}", e.error));
let file = e.file.display().to_string();
if !file.is_empty() {
msg.note(format!("failed to create or modify \"{file}\""));
msg.note(format!("failed to create or modify {e}"));
} else {
msg.note(format!("failed to create or modify file: {e}"));
Comment on lines +763 to +765
Copy link
Contributor

@notriddle notriddle Aug 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
msg.note(format!("failed to create or modify {e}"));
} else {
msg.note(format!("failed to create or modify file: {e}"));
msg.note(format!("failed to create or modify \"{file}\": {e}"));
} else {
msg.note(format!("failed to create or modify file: {e}"));

Copy link
Member Author

Choose a reason for hiding this comment

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

No, it's included in the error message if it contains a path, hence why I make the check to prevent displaying it twice.

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay, sure. That makes sense.

}
msg.emit();
}
Expand Down
Loading