Skip to content

Commit cb1874f

Browse files
Add notes about stabilized APIs
1 parent cb5e0a0 commit cb1874f

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

src/release/release-notes.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,26 @@ The release note text is automatically pulled in subsequent steps, and should us
3535

3636
* Compatibility Notes
3737
* Library
38+
* Stabilized APIs
39+
* Const Stabilized APIs
3840
* Language
3941
* Compiler
4042
* Internal Changes
4143
* Other
4244

45+
Stabilized APIs and Const Stabilized APIs should both be formatted roughly as follows:
46+
47+
```
48+
- [`std::ptr::null_mut`](https://doc.rust-lang.org/std/ptr/fn.null_mut.html)
49+
```
50+
51+
Note that:
52+
53+
* this is not a PR link, but directly links the standard library docs.
54+
* the link is to stable docs (and so may not actually work at time of writing)
55+
* the API is directly noted. Sometimes we compress APIs (e.g., `uN` for
56+
unsigned integers) to avoid too much text.
57+
4358
## Release team: Step 3: Confirm all issues/PRs needing relnotes are labeled `relnotes`
4459

4560
This steps should happen in the first 3 weeks of the beta period (earlier is
@@ -81,14 +96,12 @@ This produces console output (stderr) like this:
8196

8297
```text
8398
Did not use "Libraries" from Tracking issue for release notes of #132515: Fix and undeprecate home_dir() <https://github.com/rust-lang/rust/issues/132650>
84-
Did not use "Stabilized APIs" from Tracking issue for release notes of #67521: Tracking issue for const `alloc::Layout` <https://github.com/rust-lang/rust/issues/134725>
8599
Did not use "Category (e.g. Language, Compiler, Libraries, Compatibility notes, ...)" from Tracking issue for release notes of #132187: Add Extend impls for tuples of arity 1 through 12 <https://github.com/rust-lang/rust/issues/133975>
86100
```
87101

88102
These lines typically mean that someone either hasn't updated or used a keyword not in the list above, for example:
89103

90104
* Libraries should be Library
91-
* Stabilized APIs is not yet supported (FIXME!)
92105
* Category ... needs updating.
93106

94107
The runner of the tool should go update these issues with the right contents

0 commit comments

Comments
 (0)