Skip to content

Commit 72237ed

Browse files
Rajkumar Natarajanmark-i-m
Rajkumar Natarajan
authored andcommitted
issue 130 stabilization guide
1 parent fe1c4b7 commit 72237ed

File tree

2 files changed

+16
-17
lines changed

2 files changed

+16
-17
lines changed

src/stabilization_guide.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ following steps.
1212
## Documentation PRs
1313

1414
If any documentation for this feature exists, it should be
15-
in the `Unstable Book`, located at `src/doc/unstable-book`.
15+
in the [`Unstable Book`], located at [`src/doc/unstable-book`].
1616
If it exists, the page for the feature gate should be removed.
1717

1818
If there was documentation there, integrating it into the
@@ -63,8 +63,7 @@ The report should contain:
6363

6464
If any member of the team responsible for tracking this
6565
feature agrees with stabilizing this feature, they will
66-
start the FCP (final-comment-period) process by
67-
commenting
66+
start the FCP (final-comment-period) process by commenting
6867

6968
```bash
7069
@rfcbot fcp merge
@@ -75,24 +74,24 @@ decision is to stabilize, we proceed to do the actual code modification.
7574

7675
## Stabilization PR
7776

78-
Once we have decided to stabilize a feature, we need to have a PR that
79-
actually makes that stabilization happen. These kinds of PRs are a
80-
great way to get involved in Rust, as they take you on a little tour
81-
through the source code.
77+
Once we have decided to stabilize a feature, we need to have
78+
a PR that actually makes that stabilization happen. These kinds
79+
of PRs are a great way to get involved in Rust, as they take
80+
you on a little tour through the source code.
8281

83-
Here is a general guide to how to stabilize a feature -- every feature
84-
is different, of course, so some features may require steps beyond
85-
what this guide talks about.
82+
Here is a general guide to how to stabilize a feature --
83+
every feature is different, of course, so some features may
84+
require steps beyond what this guide talks about.
8685

87-
Note: Before we stabilize any feature, it's the rule that it should appear
88-
in the documentation.
86+
Note: Before we stabilize any feature, it's the rule that it
87+
should appear in the documentation.
8988

9089
### Updating the feature-gate listing
9190

9291
There is a central listing of feature-gates in
9392
[`src/libsyntax/feature_gate.rs`]. Search for the `declare_features!`
94-
macro. There should be an entry for the feature you are aiming to
95-
stabilize, something like (this example is taken from
93+
macro. There should be an entry for the feature you are aiming
94+
to stabilize, something like (this example is taken from
9695
[rust-lang/rust#32409]:
9796

9897
```rust,ignore
@@ -177,3 +176,5 @@ if something { /* XXX */ }
177176
[The Reference]: https://github.com/rust-lang-nursery/reference
178177
[The Book]: https://github.com/rust-lang/book
179178
[Rust by Example]: https://github.com/rust-lang/rust-by-example
179+
[`Unstable Book`]: https://doc.rust-lang.org/unstable-book/index.html
180+
[`src/doc/unstable-book`]: https://github.com/rust-lang/rust/tree/master/src/doc/unstable-book

src/walkthrough.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,6 @@ After this, [a PR is made][stab] to remove the feature gate, enabling the featur
258258
default (on the 2018 edition). A note is added to the [Release notes][relnotes]
259259
about the feature.
260260

261-
[stab]: https://github.com/rust-lang/rust/pull/56245
262-
263-
[feature-stab]: https://forge.rust-lang.org/stabilization-guide.html
261+
Steps to stabilize the feature can be found at [Stabilizing Features](./stabilization_guide.md).
264262

265263
[relnotes]: https://github.com/rust-lang/rust/blob/master/RELEASES.md

0 commit comments

Comments
 (0)