about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorRajkumar Natarajan <rajkumar.natarajan@synacor.com>2019-01-17 17:04:03 -0500
committerWho? Me?! <mark-i-m@users.noreply.github.com>2019-01-17 18:56:02 -0600
commitf2426a11e25b233bb7db7a1ae674dcc278a55bc5 (patch)
tree83e7701e8896b42c7585d8f8b2493dc613104cc7 /src/doc/rustc-dev-guide
parent2e169e078ccc36204a25d9250173983ef5ac7e58 (diff)
issue 130 stabilization guide
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/stabilization_guide.md29
-rw-r--r--src/doc/rustc-dev-guide/src/walkthrough.md4
2 files changed, 16 insertions, 17 deletions
diff --git a/src/doc/rustc-dev-guide/src/stabilization_guide.md b/src/doc/rustc-dev-guide/src/stabilization_guide.md
index 6296aaa0118..eb2c642989b 100644
--- a/src/doc/rustc-dev-guide/src/stabilization_guide.md
+++ b/src/doc/rustc-dev-guide/src/stabilization_guide.md
@@ -12,7 +12,7 @@ following steps.
 ## Documentation PRs
 
 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 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
 feature agrees with stabilizing this feature, they will
-start the FCP (final-comment-period) process by
-commenting
+start the FCP (final-comment-period) process by commenting
 
 ```bash
 @rfcbot fcp merge
@@ -75,24 +74,24 @@ decision is to stabilize, we proceed to do the actual code modification.
 
 ## Stabilization PR
 
-Once we have decided to stabilize a feature, we need to have a PR that
-actually makes that stabilization happen. These kinds of PRs are a
-great way to get involved in Rust, as they take you on a little tour
-through the source code.
+Once we have decided to stabilize a feature, we need to have
+a PR that actually makes that stabilization happen. These kinds
+of PRs are a great way to get involved in Rust, as they take
+you on a little tour through the source code.
 
-Here is a general guide to how to stabilize a feature -- every feature
-is different, of course, so some features may require steps beyond 
-what this guide talks about.
+Here is a general guide to how to stabilize a feature --
+every feature is different, of course, so some features may
+require steps beyond what this guide talks about.
 
-Note: Before we stabilize any feature, it's the rule that it should appear
-in the documentation.
+Note: Before we stabilize any feature, it's the rule that it
+should appear in the documentation.
 
 ### Updating the feature-gate listing
 
 There is a central listing of feature-gates in
 [`src/libsyntax/feature_gate.rs`]. Search for the `declare_features!`
-macro. There should be an entry for the feature you are aiming to
-stabilize, something like (this example is taken from
+macro. There should be an entry for the feature you are aiming
+to stabilize, something like (this example is taken from
 [rust-lang/rust#32409]:
 
 ```rust,ignore
@@ -177,3 +176,5 @@ if something { /* XXX */ }
 [The Reference]: https://github.com/rust-lang-nursery/reference
 [The Book]: https://github.com/rust-lang/book
 [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
\ No newline at end of file
diff --git a/src/doc/rustc-dev-guide/src/walkthrough.md b/src/doc/rustc-dev-guide/src/walkthrough.md
index fa259de991c..2823426be10 100644
--- a/src/doc/rustc-dev-guide/src/walkthrough.md
+++ b/src/doc/rustc-dev-guide/src/walkthrough.md
@@ -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]
 about the feature.
 
-[stab]: https://github.com/rust-lang/rust/pull/56245
-
-[feature-stab]: https://forge.rust-lang.org/stabilization-guide.html
+Steps to stabilize the feature can be found at [Stabilizing Features](./stabilization_guide.md).
 
 [relnotes]: https://github.com/rust-lang/rust/blob/master/RELEASES.md