Remove the common prelude module

This fixes the issues described in
https://github.com/rust-lang/rust/issues/136102. Primarily, this
resolves some issues with how the documentation for the prelude is
generated:

- It avoids showing "unstable" for macros in the prelude that are
  actually stable.
- Avoids duplication of some pages due to the previous lack of
  `doc(no_inline)`.
- Makes the different edition preludes consistent, and sets a pattern
  that can be used by future editions.

We may need to rearrange these modules in the future if we decide to
remove anything from the prelude again. If we do, I think we should look
into a different solution that avoids the documentation problems.
This commit is contained in:
Eric Huss
2025-02-11 12:03:22 -08:00
parent 8c61cd4df8
commit 8c24c0a023
5 changed files with 13 additions and 25 deletions

View File

@@ -9,16 +9,7 @@
#![stable(feature = "core_prelude", since = "1.4.0")]
mod common;
/// The first version of the prelude of The Rust Standard Library.
///
/// See the [module-level documentation](self) for more.
#[stable(feature = "rust1", since = "1.0.0")]
pub mod v1 {
#[stable(feature = "rust1", since = "1.0.0")]
pub use super::common::*;
}
pub mod v1;
/// The 2015 version of the core prelude.
///
@@ -64,7 +55,8 @@ pub mod rust_2021 {
#[stable(feature = "prelude_2024", since = "1.85.0")]
pub mod rust_2024 {
#[stable(feature = "rust1", since = "1.0.0")]
pub use super::common::*;
#[doc(no_inline)]
pub use super::v1::*;
#[stable(feature = "prelude_2021", since = "1.55.0")]
#[doc(no_inline)]

View File

@@ -1,7 +1,9 @@
//! Items common to the prelude of all editions.
//! The first version of the core prelude.
//!
//! See the [module-level documentation](super) for more.
#![stable(feature = "core_prelude", since = "1.4.0")]
// No formatting: this file is nothing but re-exports, and their order is worth preserving.
#![cfg_attr(rustfmt, rustfmt::skip)]

View File

@@ -111,16 +111,7 @@
#![stable(feature = "rust1", since = "1.0.0")]
mod common;
/// The first version of the prelude of The Rust Standard Library.
///
/// See the [module-level documentation](self) for more.
#[stable(feature = "rust1", since = "1.0.0")]
pub mod v1 {
#[stable(feature = "rust1", since = "1.0.0")]
pub use super::common::*;
}
pub mod v1;
/// The 2015 version of the prelude of The Rust Standard Library.
///
@@ -162,7 +153,8 @@ pub mod rust_2021 {
#[stable(feature = "prelude_2024", since = "1.85.0")]
pub mod rust_2024 {
#[stable(feature = "rust1", since = "1.0.0")]
pub use super::common::*;
#[doc(no_inline)]
pub use super::v1::*;
#[stable(feature = "prelude_2024", since = "1.85.0")]
#[doc(no_inline)]

View File

@@ -1,7 +1,9 @@
//! Items common to the prelude of all editions.
//! The first version of the prelude of The Rust Standard Library.
//!
//! See the [module-level documentation](super) for more.
#![stable(feature = "rust1", since = "1.0.0")]
// No formatting: this file is nothing but re-exports, and their order is worth preserving.
#![cfg_attr(rustfmt, rustfmt::skip)]

View File

@@ -9,7 +9,7 @@ const EXPECTED = [
{
'query': 'prelude::vec',
'others': [
{ 'path': 'std::prelude::rust_2024', 'name': 'Vec' },
{ 'path': 'std::prelude::v1', 'name': 'Vec' },
],
},
{