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

issue 130 stabilization guide

This commit is contained in:
Rajkumar Natarajan 2019-01-17 17:04:03 -05:00 committed by Who? Me?!
parent 8c5ceb8126
commit 5025bb7ca3
2 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/stabilization_guide.md
View File

@ -12,7 +12,7 @@ following steps.
## Documentation PRs ## Documentation PRs
If any documentation for this feature exists, it should be If any documentation for this feature exists, it should be
in the `Unstable Book`, located at `src/doc/unstable-book`. in the [`Unstable Book`], located at [`src/doc/unstable-book`].
If it exists, the page for the feature gate should be removed. If it exists, the page for the feature gate should be removed.
If there was documentation there, integrating it into the If there was documentation there, integrating it into the
@ -63,8 +63,7 @@ The report should contain:
If any member of the team responsible for tracking this If any member of the team responsible for tracking this
feature agrees with stabilizing this feature, they will feature agrees with stabilizing this feature, they will
start the FCP (final-comment-period) process by start the FCP (final-comment-period) process by commenting
commenting
```bash ```bash
@rfcbot fcp merge @rfcbot fcp merge
@ -75,24 +74,24 @@ decision is to stabilize, we proceed to do the actual code modification.
## Stabilization PR ## Stabilization PR
Once we have decided to stabilize a feature, we need to have a PR that Once we have decided to stabilize a feature, we need to have
actually makes that stabilization happen. These kinds of PRs are a a PR that actually makes that stabilization happen. These kinds
great way to get involved in Rust, as they take you on a little tour of PRs are a great way to get involved in Rust, as they take
through the source code. you on a little tour through the source code.
Here is a general guide to how to stabilize a feature -- every feature Here is a general guide to how to stabilize a feature --
is different, of course, so some features may require steps beyond every feature is different, of course, so some features may
what this guide talks about. require steps beyond what this guide talks about.
Note: Before we stabilize any feature, it's the rule that it should appear Note: Before we stabilize any feature, it's the rule that it
in the documentation. 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 feature-gates in
[`src/libsyntax/feature_gate.rs`]. Search for the `declare_features!` [`src/libsyntax/feature_gate.rs`]. Search for the `declare_features!`
macro. There should be an entry for the feature you are aiming to macro. There should be an entry for the feature you are aiming
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]:
```rust,ignore ```rust,ignore
@ -177,3 +176,5 @@ if something { /* XXX */ }
[The Reference]: https://github.com/rust-lang-nursery/reference [The Reference]: https://github.com/rust-lang-nursery/reference
[The Book]: https://github.com/rust-lang/book [The Book]: https://github.com/rust-lang/book
[Rust by Example]: https://github.com/rust-lang/rust-by-example [Rust by Example]: https://github.com/rust-lang/rust-by-example
[`Unstable Book`]: https://doc.rust-lang.org/unstable-book/index.html
[`src/doc/unstable-book`]: https://github.com/rust-lang/rust/tree/master/src/doc/unstable-book

4
src/walkthrough.md
View File

@ -258,8 +258,6 @@ After this, [a PR is made][stab] to remove the feature gate, enabling the featur
default (on the 2018 edition). A note is added to the [Release notes][relnotes] default (on the 2018 edition). A note is added to the [Release notes][relnotes]
about the feature. about the feature.
[stab]: https://github.com/rust-lang/rust/pull/56245 Steps to stabilize the feature can be found at [Stabilizing Features](./stabilization_guide.md).
[feature-stab]: https://forge.rust-lang.org/stabilization-guide.html
[relnotes]: https://github.com/rust-lang/rust/blob/master/RELEASES.md [relnotes]: https://github.com/rust-lang/rust/blob/master/RELEASES.md