about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJulian Frimmel <julian.frimmel@gmail.com>2021-03-07 10:52:35 +0100
committerJulian Frimmel <julian.frimmel@gmail.com>2021-03-07 21:08:07 +0100
commitc40ef91f7652f37c9bc959953bb4a81d86c2dc1a (patch)
tree2ab788aecfaef2dcf9e900e8eb335cbe87aefc85
parent51748a8fc77283914d4135f31b5966a407208187 (diff)
downloadrust-c40ef91f7652f37c9bc959953bb4a81d86c2dc1a.tar.gz
rust-c40ef91f7652f37c9bc959953bb4a81d86c2dc1a.zip
Add note about the `#[doc(no-inline)]` usage
This is required to correctly build the documentation (including all
submodules, that are only available in certain targets).
-rw-r--r--library/std/src/lib.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/library/std/src/lib.rs b/library/std/src/lib.rs
index 72b86338d2c..66b58660540 100644
--- a/library/std/src/lib.rs
+++ b/library/std/src/lib.rs
@@ -394,7 +394,11 @@ pub use alloc_crate::vec;
 #[stable(feature = "rust1", since = "1.0.0")]
 pub use core::any;
 #[stable(feature = "simd_arch", since = "1.27.0")]
-#[doc(no_inline)]
+// The `no_inline`-attribute is required to make the documentation of all
+// targets available.
+// See https://github.com/rust-lang/rust/pull/57808#issuecomment-457390549 for
+// more information.
+#[doc(no_inline)] // Note (#82861): required for correct documentation
 pub use core::arch;
 #[stable(feature = "core_array", since = "1.36.0")]
 pub use core::array;