Skip to content

Emit a warning instead of an error if --generate-link-to-definition is used with other output formats than HTML #129050

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 3 commits into from
Aug 14, 2024
Merged

Emit a warning instead of an error if --generate-link-to-definition is used with other output formats than HTML #129050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53e87d2
Remove duplicated rustdoc ui test
GuillaumeGomez Aug 13, 2024
d2177d9
Emit a warning instead of an error if `--generate-link-to-definition`…
GuillaumeGomez Aug 13, 2024
afbab80
Update rustdoc-ui test for `--generate-link-to-definition` option
GuillaumeGomez Aug 13, 2024
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
8 changes: 5 additions & 3 deletions src/librustdoc/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -733,9 +733,11 @@ impl Options {
let html_no_source = matches.opt_present("html-no-source");

if generate_link_to_definition && (show_coverage || output_format != OutputFormat::Html) {
dcx.fatal(
"--generate-link-to-definition option can only be used with HTML output format",
);
dcx.struct_warn(
"`--generate-link-to-definition` option can only be used with HTML output format",
)
.with_note("`--generate-link-to-definition` option will be ignored")
.emit();
}

let scrape_examples_options = ScrapeExamplesOptions::new(matches, dcx);
Expand Down
1 change: 1 addition & 0 deletions tests/rustdoc-ui/generate-link-to-definition/generate-link-to-definition-opt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
// option can only be used with HTML generation.

//@ compile-flags: -Zunstable-options --generate-link-to-definition --output-format json
//@ check-pass

pub fn f() {}
4 changes: 3 additions & 1 deletion tests/rustdoc-ui/generate-link-to-definition/generate-link-to-definition-opt.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
error: --generate-link-to-definition option can only be used with HTML output format
warning: `--generate-link-to-definition` option can only be used with HTML output format
|
= note: `--generate-link-to-definition` option will be ignored

6 changes: 0 additions & 6 deletions tests/rustdoc-ui/generate-link-to-definition/generate-link-to-definition-opt2.rs
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions tests/rustdoc-ui/generate-link-to-definition/generate-link-to-definition-opt2.stderr
View file
Open in desktop

This file was deleted.

Loading