Auto merge of #85990 - jyn514:channel-replace-rustdoc, r=Manishearth
rustdoc: link consistently to stable/beta in diagnostic messages Builds on https://github.com/rust-lang/rust/pull/84942. This makes the diagnostics consistent with the links.
This commit is contained in:
@@ -557,7 +557,8 @@ crate fn has_doc_flag(attrs: ty::Attributes<'_>, flag: Symbol) -> bool {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
/// A link to `doc.rust-lang.org` that includes the channel name.
|
/// A link to `doc.rust-lang.org` that includes the channel name. Use this instead of manual links
|
||||||
|
/// so that the channel is consistent.
|
||||||
///
|
///
|
||||||
/// Set by `bootstrap::Builder::doc_rust_lang_org_channel` in order to keep tests passing on beta/stable.
|
/// Set by `bootstrap::Builder::doc_rust_lang_org_channel` in order to keep tests passing on beta/stable.
|
||||||
crate const DOC_RUST_LANG_ORG_CHANNEL: &'static str = env!("DOC_RUST_LANG_ORG_CHANNEL");
|
crate const DOC_RUST_LANG_ORG_CHANNEL: &'static str = env!("DOC_RUST_LANG_ORG_CHANNEL");
|
||||||
|
|||||||
@@ -399,15 +399,18 @@ crate fn run_global_ctxt(
|
|||||||
let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
|
let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
|
||||||
|
|
||||||
if krate.module.doc_value().map(|d| d.is_empty()).unwrap_or(true) {
|
if krate.module.doc_value().map(|d| d.is_empty()).unwrap_or(true) {
|
||||||
let help = "The following guide may be of use:\n\
|
let help = format!(
|
||||||
https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html";
|
"The following guide may be of use:\n\
|
||||||
|
{}/rustdoc/how-to-write-documentation.html",
|
||||||
|
crate::DOC_RUST_LANG_ORG_CHANNEL
|
||||||
|
);
|
||||||
tcx.struct_lint_node(
|
tcx.struct_lint_node(
|
||||||
crate::lint::MISSING_CRATE_LEVEL_DOCS,
|
crate::lint::MISSING_CRATE_LEVEL_DOCS,
|
||||||
DocContext::as_local_hir_id(tcx, krate.module.def_id).unwrap(),
|
DocContext::as_local_hir_id(tcx, krate.module.def_id).unwrap(),
|
||||||
|lint| {
|
|lint| {
|
||||||
let mut diag =
|
let mut diag =
|
||||||
lint.build("no documentation found for this crate's top-level module");
|
lint.build("no documentation found for this crate's top-level module");
|
||||||
diag.help(help);
|
diag.help(&help);
|
||||||
diag.emit();
|
diag.emit();
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -613,7 +613,10 @@ fn usage(argv0: &str) {
|
|||||||
}
|
}
|
||||||
println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
|
println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
|
||||||
println!(" @path Read newline separated options from `path`\n");
|
println!(" @path Read newline separated options from `path`\n");
|
||||||
println!("More information available at https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html")
|
println!(
|
||||||
|
"More information available at {}/rustdoc/what-is-rustdoc.html",
|
||||||
|
DOC_RUST_LANG_ORG_CHANNEL
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// A result type used by several functions under `main()`.
|
/// A result type used by several functions under `main()`.
|
||||||
|
|||||||
@@ -1999,8 +1999,11 @@ fn disambiguator_error(
|
|||||||
) {
|
) {
|
||||||
diag_info.link_range = disambiguator_range;
|
diag_info.link_range = disambiguator_range;
|
||||||
report_diagnostic(cx.tcx, BROKEN_INTRA_DOC_LINKS, msg, &diag_info, |diag, _sp| {
|
report_diagnostic(cx.tcx, BROKEN_INTRA_DOC_LINKS, msg, &diag_info, |diag, _sp| {
|
||||||
let msg = "see https://doc.rust-lang.org/nightly/rustdoc/linking-to-items-by-name.html#namespaces-and-disambiguators for more info about disambiguators";
|
let msg = format!(
|
||||||
diag.note(msg);
|
"see {}/rustdoc/linking-to-items-by-name.html#namespaces-and-disambiguators for more info about disambiguators",
|
||||||
|
crate::DOC_RUST_LANG_ORG_CHANNEL
|
||||||
|
);
|
||||||
|
diag.note(&msg);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user