Skip to content

Migrate rustdoc diagnostics to translatable diagnostics #112807

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

Closed
wants to merge 4 commits into from
Closed

Migrate rustdoc diagnostics to translatable diagnostics #112807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a4ead9
Migrate diagnostics on `lib.rs`
nicklimmm Jun 19, 2023
f1763af
Convert error messages to lowercase
nicklimmm Jun 22, 2023
b5be644
Address comments, migrate more diagnostics
nicklimmm Jun 26, 2023
cf544bd
Temp commit
nicklimmm Aug 7, 2023
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: 2 additions & 2 deletions src/librustdoc/clean/cfg.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ impl<'a> fmt::Display for Display<'a> {
write!(fmt, "`{}`", feat)?;
}
} else {
write_with_opt_paren(fmt, !sub_cfg.is_all(), Display(sub_cfg, self.1))?;
write_with_opt_paren(fmt, !sub_cfg.is_all(), Display(&sub_cfg, self.1))?;
}
}
Ok(())
Expand Down Expand Up @@ -476,7 +476,7 @@ impl<'a> fmt::Display for Display<'a> {
write!(fmt, "`{}`", feat)?;
}
} else {
write_with_opt_paren(fmt, !sub_cfg.is_simple(), Display(sub_cfg, self.1))?;
write_with_opt_paren(fmt, !sub_cfg.is_simple(), Display(&sub_cfg, self.1))?;
}
}
Ok(())
Expand Down
87 changes: 34 additions & 53 deletions src/librustdoc/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ use rustc_span::edition::Edition;
use rustc_target::spec::TargetTriple;

use crate::core::new_handler;
use crate::errors::{
ArgumentsToThemeMustBeFiles, ArgumentsToThemeMustHaveACssExtension,
CannotUseBothOutDirAndOutputAtOnce, ErrorLoadingThemeFile, ExtendCssArgMustBeAFile,
FlagIsDeprecated, FlagNoLongerFunctions,
GenerateLinkToDefinitionOptionCanOnlyBeUsedWithHtmlOutputFormat,
HtmlOutputFormatUnsupportedForShowCoverageOption, IndexPageArgMustBeAFile, MissingFileOperand,
TestFlagMustBePassedToEnableNoRun, ThemeFileMissingCssRulesFromDefaultTheme,
TooManyFileOperands, UnknownCrateType, UnknownInputFormat, UnrecognizedEmissionType,
};
use crate::externalfiles::ExternalHtml;
use crate::html;
use crate::html::markdown::IdMap;
Expand Down Expand Up @@ -381,7 +390,7 @@ impl Options {
match kind.parse() {
Ok(kind) => emit.push(kind),
Err(()) => {
diag.err(format!("unrecognized emission type: {}", kind));
diag.emit_err(UnrecognizedEmissionType { kind });
return Err(1);
}
}
Expand All @@ -406,6 +415,8 @@ impl Options {
) {
Ok(p) => p,
Err(e) => {
#[allow(rustc::untranslatable_diagnostic)]
#[allow(rustc::diagnostic_outside_of_impl)]
diag.struct_err(e).emit();
return Err(1);
}
Expand Down Expand Up @@ -437,10 +448,10 @@ impl Options {
let input = PathBuf::from(if describe_lints {
"" // dummy, this won't be used
} else if matches.free.is_empty() {
diag.struct_err("missing file operand").emit();
diag.emit_err(MissingFileOperand);
return Err(1);
} else if matches.free.len() > 1 {
diag.struct_err("too many file operands").emit();
diag.emit_err(TooManyFileOperands);
return Err(1);
} else {
&matches.free[0]
Expand All @@ -455,6 +466,8 @@ impl Options {
let extern_html_root_urls = match parse_extern_html_roots(matches) {
Ok(ex) => ex,
Err(err) => {
#[allow(rustc::untranslatable_diagnostic)]
#[allow(rustc::diagnostic_outside_of_impl)]
diag.struct_err(err).emit();
return Err(1);
}
Expand Down Expand Up @@ -514,15 +527,15 @@ impl Options {
let no_run = matches.opt_present("no-run");

if !should_test && no_run {
diag.err("the `--test` flag must be passed to enable `--no-run`");
diag.emit_err(TestFlagMustBePassedToEnableNoRun);
return Err(1);
}

let out_dir = matches.opt_str("out-dir").map(|s| PathBuf::from(&s));
let output = matches.opt_str("output").map(|s| PathBuf::from(&s));
let output = match (out_dir, output) {
(Some(_), Some(_)) => {
diag.struct_err("cannot use both 'out-dir' and 'output' at once").emit();
diag.emit_err(CannotUseBothOutDirAndOutputAtOnce);
return Err(1);
}
(Some(out_dir), None) => out_dir,
Expand All @@ -537,7 +550,7 @@ impl Options {

if let Some(ref p) = extension_css {
if !p.is_file() {
diag.struct_err("option --extend-css argument must be a file").emit();
diag.emit_err(ExtendCssArgMustBeAFile);
return Err(1);
}
}
Expand All @@ -549,6 +562,8 @@ impl Options {
) {
Ok(p) => p,
Err(e) => {
#[allow(rustc::untranslatable_diagnostic)]
#[allow(rustc::diagnostic_outside_of_impl)]
diag.struct_err(e).emit();
return Err(1);
}
Expand All @@ -558,32 +573,19 @@ impl Options {
matches.opt_strs("theme").iter().map(|s| (PathBuf::from(&s), s.to_owned()))
{
if !theme_file.is_file() {
diag.struct_err(format!("invalid argument: \"{}\"", theme_s))
.help("arguments to --theme must be files")
.emit();
diag.emit_err(ArgumentsToThemeMustBeFiles { theme: theme_s });
return Err(1);
}
if theme_file.extension() != Some(OsStr::new("css")) {
diag.struct_err(format!("invalid argument: \"{}\"", theme_s))
.help("arguments to --theme must have a .css extension")
.emit();
diag.emit_err(ArgumentsToThemeMustHaveACssExtension { theme: theme_s });
return Err(1);
}
let (success, ret) = theme::test_theme_against(&theme_file, &paths, &diag);
if !success {
diag.struct_err(format!("error loading theme file: \"{}\"", theme_s)).emit();
diag.emit_err(ErrorLoadingThemeFile { theme: theme_s });
return Err(1);
} else if !ret.is_empty() {
diag.struct_warn(format!(
"theme file \"{}\" is missing CSS rules from the default theme",
theme_s
))
.warn("the theme may appear incorrect when loaded")
.help(format!(
"to see what rules are missing, call `rustdoc --check-theme \"{}\"`",
theme_s
))
.emit();
diag.emit_warning(ThemeFileMissingCssRulesFromDefaultTheme { theme: theme_s });
}
themes.push(StylePath { path: theme_file });
}
Expand All @@ -610,15 +612,15 @@ impl Options {
match matches.opt_str("r").as_deref() {
Some("rust") | None => {}
Some(s) => {
diag.struct_err(format!("unknown input format: {}", s)).emit();
diag.emit_err(UnknownInputFormat { format: s });
return Err(1);
}
}

let index_page = matches.opt_str("index-page").map(|s| PathBuf::from(&s));
if let Some(ref index_page) = index_page {
if !index_page.is_file() {
diag.struct_err("option `--index-page` argument must be a file").emit();
diag.emit_err(IndexPageArgMustBeAFile);
return Err(1);
}
}
Expand All @@ -630,7 +632,7 @@ impl Options {
let crate_types = match parse_crate_types_from_list(matches.opt_strs("crate-type")) {
Ok(types) => types,
Err(e) => {
diag.struct_err(format!("unknown crate type: {}", e)).emit();
diag.emit_err(UnknownCrateType { err: e });
return Err(1);
}
};
Expand All @@ -639,15 +641,14 @@ impl Options {
Some(s) => match OutputFormat::try_from(s.as_str()) {
Ok(out_fmt) => {
if !out_fmt.is_json() && show_coverage {
diag.struct_err(
"html output format isn't supported for the --show-coverage option",
)
.emit();
diag.emit_err(HtmlOutputFormatUnsupportedForShowCoverageOption);
return Err(1);
}
out_fmt
}
Err(e) => {
#[allow(rustc::untranslatable_diagnostic)]
#[allow(rustc::diagnostic_outside_of_impl)]
diag.struct_err(e).emit();
return Err(1);
}
Expand Down Expand Up @@ -692,10 +693,7 @@ impl Options {
matches.opt_present("extern-html-root-takes-precedence");

if generate_link_to_definition && (show_coverage || output_format != OutputFormat::Html) {
diag.struct_err(
"--generate-link-to-definition option can only be used with HTML output format",
)
.emit();
diag.emit_err(GenerateLinkToDefinitionOptionCanOnlyBeUsedWithHtmlOutputFormat);
return Err(1);
}

Expand Down Expand Up @@ -789,32 +787,15 @@ fn check_deprecated_options(matches: &getopts::Matches, diag: &rustc_errors::Han

for &flag in deprecated_flags.iter() {
if matches.opt_present(flag) {
diag.struct_warn(format!("the `{}` flag is deprecated", flag))
.note(
"see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
for more information",
)
.emit();
diag.emit_warning(FlagIsDeprecated { flag });
}
}

let removed_flags = ["plugins", "plugin-path", "no-defaults", "passes", "input-format"];

for &flag in removed_flags.iter() {
if matches.opt_present(flag) {
let mut err = diag.struct_warn(format!("the `{}` flag no longer functions", flag));
err.note(
"see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
for more information",
);

if flag == "no-defaults" || flag == "passes" {
err.help("you may want to use --document-private-items");
} else if flag == "plugins" || flag == "plugin-path" {
err.warn("see CVE-2018-1000622");
}

err.emit();
diag.emit_warning(FlagNoLongerFunctions::new(flag));
}
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/librustdoc/core.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,8 @@ pub(crate) fn create_config(
}
}

#[allow(rustc::untranslatable_diagnostic)]
#[allow(rustc::diagnostic_outside_of_impl)]
pub(crate) fn run_global_ctxt(
tcx: TyCtxt<'_>,
show_coverage: bool,
Expand Down
Loading