Skip to content

Commit e78455f

Browse files
GH Actions RunnerGH Actions Runner
GH Actions Runner
authored and
GH Actions Runner
committed
publish: Merge pull request #43 from est31/stabilization_placeholder
generated from commit 0c50d28
1 parent 96a44a4 commit e78455f

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

feature-lifecycle/stabilization.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -184,10 +184,10 @@ <h3 id="update-the-stability-attributes-on-the-items"><a class="header" href="#u
184184
<pre><code class="language-rust ignore">#[unstable(feature = &quot;total_cmp&quot;, issue = &quot;72599&quot;)]
185185
pub fn total_cmp(&amp;self, other: &amp;Self) -&gt; crate::cmp::Ordering { ... }
186186
</code></pre>
187-
<p>You'll need to change that to a <code>#[stable]</code> attribute with a version:</p>
188-
<pre><code class="language-rust ignore">#[stable(feature = &quot;total_cmp&quot;, since = &quot;1.61.0&quot;)]
187+
<p>You'll need to change that to a <code>#[stable]</code> attribute with the version set to the placeholder <code>CURRENT_RUSTC_VERSION</code>:</p>
188+
<pre><code class="language-rust ignore">#[stable(feature = &quot;total_cmp&quot;, since = &quot;CURRENT_RUSTC_VERSION&quot;)]
189189
</code></pre>
190-
<p>Note that, the version number is updated to be the version number of the stable release where this feature will appear. This can be found by consulting <a href="https://github.com/rust-lang/rust/blob/master/src/version"><code>src/version</code></a> on the current master branch of <code>rust-lang/rust</code>.</p>
190+
<p>Note that other <code>#[stable]</code> attributes may contain spelled out version numbers, but you should not spell out any version number as it might get outdated by the time your pull request merges.</p>
191191
<h3 id="remove-feature-gates-from-doctests"><a class="header" href="#remove-feature-gates-from-doctests">Remove feature gates from doctests</a></h3>
192192
<p>All the doctests on the items being stabilized will be enabling the unstable feature, so now that it's stable those attributes are no longer needed and should be removed.</p>
193193
<pre><code class="language-diff"> /// # Examples
@@ -213,9 +213,9 @@ <h2 id="stabilization-pr-checklist"><a class="header" href="#stabilization-pr-ch
213213
<li>Create a stabiliation report in the tracking issue for the feature being stabilized.</li>
214214
<li>(Optional) For partial stabilizations, create a new partial stabilization PR for the subset of the issue being stabilized.</li>
215215
<li>Ask a <strong>@rust-lang/libs-api</strong> member to start an FCP on the tracking issue and wait for the FCP to complete (with <code>disposition-merge</code>).</li>
216-
<li>Change <code>#[unstable(...)]</code> to <code>#[stable(since = &quot;version&quot;)]</code>. <code>version</code> should be the <em>current nightly</em>, i.e. stable+2. You can see which version is the current nightly in <a href="https://github.com/rust-lang/rust/blob/master/src/version"><code>src/version</code></a> on the master branch of <code>rust-lang/rust</code>.</li>
216+
<li>Change <code>#[unstable(...)]</code> to <code>#[stable(since = &quot;CURRENT_RUSTC_VERSION&quot;)]</code>. <code>CURRENT_RUSTC_VERSION</code> here is meant in a literal sense and not to be replaced with the spelled out version number.</li>
217217
<li>Remove <code>#![feature(...)]</code> from any test or doc-test for this API. If the feature is used in the compiler or tools, remove it from there as well.</li>
218-
<li>If applicable, change <code>#[rustc_const_unstable(...)]</code> to <code>#[rustc_const_stable(since = &quot;version&quot;)]</code>.</li>
218+
<li>If applicable, change <code>#[rustc_const_unstable(...)]</code> to <code>#[rustc_const_stable(since = &quot;CURRENT_RUSTC_VERSION&quot;)]</code>.</li>
219219
<li>Open a PR against <code>rust-lang/rust</code>.
220220
<ul>
221221
<li>Add the appropriate labels: <code>@rustbot modify labels: +T-libs-api</code>.</li>

print.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -397,10 +397,10 @@ <h3 id="update-the-stability-attributes-on-the-items"><a class="header" href="#u
397397
<pre><code class="language-rust ignore">#[unstable(feature = &quot;total_cmp&quot;, issue = &quot;72599&quot;)]
398398
pub fn total_cmp(&amp;self, other: &amp;Self) -&gt; crate::cmp::Ordering { ... }
399399
</code></pre>
400-
<p>You'll need to change that to a <code>#[stable]</code> attribute with a version:</p>
401-
<pre><code class="language-rust ignore">#[stable(feature = &quot;total_cmp&quot;, since = &quot;1.61.0&quot;)]
400+
<p>You'll need to change that to a <code>#[stable]</code> attribute with the version set to the placeholder <code>CURRENT_RUSTC_VERSION</code>:</p>
401+
<pre><code class="language-rust ignore">#[stable(feature = &quot;total_cmp&quot;, since = &quot;CURRENT_RUSTC_VERSION&quot;)]
402402
</code></pre>
403-
<p>Note that, the version number is updated to be the version number of the stable release where this feature will appear. This can be found by consulting <a href="https://github.com/rust-lang/rust/blob/master/src/version"><code>src/version</code></a> on the current master branch of <code>rust-lang/rust</code>.</p>
403+
<p>Note that other <code>#[stable]</code> attributes may contain spelled out version numbers, but you should not spell out any version number as it might get outdated by the time your pull request merges.</p>
404404
<h3 id="remove-feature-gates-from-doctests"><a class="header" href="#remove-feature-gates-from-doctests">Remove feature gates from doctests</a></h3>
405405
<p>All the doctests on the items being stabilized will be enabling the unstable feature, so now that it's stable those attributes are no longer needed and should be removed.</p>
406406
<pre><code class="language-diff"> /// # Examples
@@ -426,9 +426,9 @@ <h2 id="stabilization-pr-checklist"><a class="header" href="#stabilization-pr-ch
426426
<li>Create a stabiliation report in the tracking issue for the feature being stabilized.</li>
427427
<li>(Optional) For partial stabilizations, create a new partial stabilization PR for the subset of the issue being stabilized.</li>
428428
<li>Ask a <strong>@rust-lang/libs-api</strong> member to start an FCP on the tracking issue and wait for the FCP to complete (with <code>disposition-merge</code>).</li>
429-
<li>Change <code>#[unstable(...)]</code> to <code>#[stable(since = &quot;version&quot;)]</code>. <code>version</code> should be the <em>current nightly</em>, i.e. stable+2. You can see which version is the current nightly in <a href="https://github.com/rust-lang/rust/blob/master/src/version"><code>src/version</code></a> on the master branch of <code>rust-lang/rust</code>.</li>
429+
<li>Change <code>#[unstable(...)]</code> to <code>#[stable(since = &quot;CURRENT_RUSTC_VERSION&quot;)]</code>. <code>CURRENT_RUSTC_VERSION</code> here is meant in a literal sense and not to be replaced with the spelled out version number.</li>
430430
<li>Remove <code>#![feature(...)]</code> from any test or doc-test for this API. If the feature is used in the compiler or tools, remove it from there as well.</li>
431-
<li>If applicable, change <code>#[rustc_const_unstable(...)]</code> to <code>#[rustc_const_stable(since = &quot;version&quot;)]</code>.</li>
431+
<li>If applicable, change <code>#[rustc_const_unstable(...)]</code> to <code>#[rustc_const_stable(since = &quot;CURRENT_RUSTC_VERSION&quot;)]</code>.</li>
432432
<li>Open a PR against <code>rust-lang/rust</code>.
433433
<ul>
434434
<li>Add the appropriate labels: <code>@rustbot modify labels: +T-libs-api</code>.</li>

searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

searchindex.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)