summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuki Okushi <jtitor@2k36.org>2021-04-06 06:24:17 +0900
committerGitHub <noreply@github.com>2021-04-06 06:24:17 +0900
commitd8c04b13a2a6eaba375bb79c1bda7ec78f820e7e (patch)
tree4ae1e5837c00634449b6529cdf352d627fb9a902
parentfb6eb4ad93afdfb7a2ccef2728fe252109331448 (diff)
parent0a351abf83f1d146e2d259d404fb16a158721391 (diff)
downloadrust-d8c04b13a2a6eaba375bb79c1bda7ec78f820e7e.tar.gz
Rollup merge of #83885 - jyn514:private-links, r=Mark-Simulacrum
Document compiler/ with -Aprivate-intra-doc-links Since compiler/ always passes --document-private-items, it's ok to link to items that are private.
-rw-r--r--compiler/rustc_errors/src/diagnostic_builder.rs9
-rw-r--r--src/bootstrap/doc.rs2
2 files changed, 2 insertions, 9 deletions
diff --git a/compiler/rustc_errors/src/diagnostic_builder.rs b/compiler/rustc_errors/src/diagnostic_builder.rs
index 3fc63b4e50c..282877d5dd1 100644
--- a/compiler/rustc_errors/src/diagnostic_builder.rs
+++ b/compiler/rustc_errors/src/diagnostic_builder.rs
@@ -45,9 +45,6 @@ macro_rules! forward {
pub fn $n:ident(&self, $($name:ident: $ty:ty),* $(,)?) -> &Self
) => {
$(#[$attrs])*
- // we always document with --document-private-items
- #[cfg_attr(not(bootstrap), allow(rustdoc::private_intra_doc_links))]
- #[cfg_attr(bootstrap, allow(private_intra_doc_links))]
#[doc = concat!("See [`Diagnostic::", stringify!($n), "()`].")]
pub fn $n(&self, $($name: $ty),*) -> &Self {
self.diagnostic.$n($($name),*);
@@ -62,9 +59,6 @@ macro_rules! forward {
) => {
$(#[$attrs])*
#[doc = concat!("See [`Diagnostic::", stringify!($n), "()`].")]
- // we always document with --document-private-items
- #[cfg_attr(not(bootstrap), allow(rustdoc::private_intra_doc_links))]
- #[cfg_attr(bootstrap, allow(private_intra_doc_links))]
pub fn $n(&mut self, $($name: $ty),*) -> &mut Self {
self.0.diagnostic.$n($($name),*);
self
@@ -82,9 +76,6 @@ macro_rules! forward {
) => {
$(#[$attrs])*
#[doc = concat!("See [`Diagnostic::", stringify!($n), "()`].")]
- // we always document with --document-private-items
- #[cfg_attr(not(bootstrap), allow(rustdoc::private_intra_doc_links))]
- #[cfg_attr(bootstrap, allow(private_intra_doc_links))]
pub fn $n<$($generic: $bound),*>(&mut self, $($name: $ty),*) -> &mut Self {
self.0.diagnostic.$n($($name),*);
self
diff --git a/src/bootstrap/doc.rs b/src/bootstrap/doc.rs
index fc79fc10fb4..f499f1a684d 100644
--- a/src/bootstrap/doc.rs
+++ b/src/bootstrap/doc.rs
@@ -549,6 +549,8 @@ impl Step for Rustc {
// Build cargo command.
let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "doc");
cargo.rustdocflag("--document-private-items");
+ // Since we always pass --document-private-items, there's no need to warn about linking to private items.
+ cargo.rustdocflag("-Arustdoc::private-intra-doc-links");
cargo.rustdocflag("--enable-index-page");
cargo.rustdocflag("-Zunstable-options");
cargo.rustdocflag("-Znormalize-docs");