Skip to content

Commit

Permalink
Update the stabilization guide to refer to the new placeholder system
Browse files Browse the repository at this point in the history
The stabilization process is changed to now use `CURRENT_RUSTC_VERSION`
instead of spelling out whatever version is currently the latest.
This placeholder will be replaced during the release process with the
correct version.
  • Loading branch information
est31 committed Aug 23, 2022
1 parent 18fc34b commit 120e92c
Showing 1 changed file with 5 additions and 21 deletions.
26 changes: 5 additions & 21 deletions src/stabilization_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,24 +99,6 @@ 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.

### Determining the stabilization version

The version in which the feature will be stabilized *must* match
the value of [the `src/version` file in `master`][src-version] when the PR is merged.

It's worth checking [the version schedule on the Forge][forge-versions] to see whether
changes are coming soon. You'll usually use the version labelled "Nightly".
"Nightly" is two versions higher than the current stable release,
since what's currently in beta will be the next stable release,
and any changes you're making now will be in the one after that.

No PR is merged instantly, so you'll want to be careful around release time.
The version bump happens [the Friday before][forge-release-process] the stable release,
not the same time as the release. So if you're opening a PR shortly before then,
be prepared to update the version, or consider just opening it for one version
higher than the current nightly, with a note saying not to merge until
after the upcoming version bump.

### Updating the feature-gate listing

There is a central listing of feature-gates in
Expand All @@ -127,7 +109,7 @@ to stabilize, something like (this example is taken from

```rust,ignore
// pub(restricted) visibilities (RFC 1422)
(active, pub_restricted, "1.9.0", Some(32409)),
(active, pub_restricted, "CURRENT_RUSTC_VERSION", Some(32409)),
```

The above line should be moved down to the area for "accepted"
Expand All @@ -136,11 +118,13 @@ When it is done, it should look like:

```rust,ignore
// pub(restricted) visibilities (RFC 1422)
(accepted, pub_restricted, "1.31.0", Some(32409)),
(accepted, pub_restricted, "CURRENT_RUSTC_VERSION", Some(32409)),
// note that we changed this
```

(The version here is the one discussed in the previous section.)
(Even though you will encounter version numbers in the file of past changes,
you should not put the rustc version you expect your stabilization to happen in,
but instead `CURRENT_RUSTC_VERSION`)

### Removing existing uses of the feature-gate

Expand Down

0 comments on commit 120e92c

Please sign in to comment.