mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update `stabilization_guide.md` (#2034)

This commit is contained in:
Folkert de Vries 2024-08-23 20:46:04 +02:00 committed by GitHub
parent 27bca443ca
commit 3f3aabc749
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/stabilization_guide.md
View File

@ -101,8 +101,8 @@ should appear in the documentation.
### Updating the feature-gate listing ### Updating the feature-gate listing
There is a central listing of feature-gates in There is a central listing of unstable feature-gates in
[`compiler/rustc_feature`]. Search for the `declare_features!` [`compiler/rustc_feature/src/unstable.rs`]. Search for the `declare_features!`
macro. There should be an entry for the feature you are aiming macro. There should be an entry for the feature you are aiming
to stabilize, something like (this example is taken from to stabilize, something like (this example is taken from
[rust-lang/rust#32409]: [rust-lang/rust#32409]:
@ -112,8 +112,8 @@ to stabilize, something like (this example is taken from
(unstable, pub_restricted, "CURRENT_RUSTC_VERSION", Some(32409)), (unstable, pub_restricted, "CURRENT_RUSTC_VERSION", Some(32409)),
``` ```
The above line should be moved down to the area for "accepted" The above line should be moved to [`compiler/rustc_feature/src/accepted.rs`].
features, declared below in a separate call to `declare_features!`. Entries in the `declare_features!` call are sorted, so find the correct place.
When it is done, it should look like: When it is done, it should look like:
```rust,ignore ```rust,ignore
@ -131,12 +131,12 @@ but instead `CURRENT_RUSTC_VERSION`)
Next search for the feature string (in this case, `pub_restricted`) Next search for the feature string (in this case, `pub_restricted`)
in the codebase to find where it appears. Change uses of in the codebase to find where it appears. Change uses of
`#![feature(XXX)]` from the `std` and any rustc crates (this includes test folders `#![feature(XXX)]` from the `std` and any rustc crates (this includes test folders
under `library/` and `compiler/` but not the toplevel `test/` one) to be under `library/` and `compiler/` but not the toplevel `tests/` one) to be
`#![cfg_attr(bootstrap, feature(XXX))]`. This includes the feature-gate `#![cfg_attr(bootstrap, feature(XXX))]`. This includes the feature-gate
only for stage0, which is built using the current beta (this is only for stage0, which is built using the current beta (this is
needed because the feature is still unstable in the current beta). needed because the feature is still unstable in the current beta).
Also, remove those strings from any tests. If there are tests Also, remove those strings from any tests (e.g. under `tests/`). If there are tests
specifically targeting the feature-gate (i.e., testing that the specifically targeting the feature-gate (i.e., testing that the
feature-gate is required to use the feature, but nothing else), feature-gate is required to use the feature, but nothing else),
simply remove the test. simply remove the test.