Send people doing *library* stabilizations over to the std-dev-guide #1317
Conversation
There was a problem hiding this comment.
I'm sometimes a little confused why some things are documented here and some are in the std dev guide. Would it make sense to try to avoid the duplication? What are the guidelines for what is here vs there?
src/stabilization_guide.md
Outdated
| found by consulting [the forge](https://forge.rust-lang.org/#current-release-versions). | ||
| Specifically, you'll want to use the version labelled "Nightly". |
There was a problem hiding this comment.
Although this is a perfectly fine way to check the version, it might be more reliable to consult src/version on master. That can help avoid confusion with the version bump that happens on the Friday before release.
I might also suggest predicting the version that it will land in. If it looks like it might land around the Friday before release, then there is risk that it will miss the release window.
Finally, I might suggest putting this discussion of determining the version into a dedicated section and removing the duplicate discussion above with lang stabilizations. For the most part, the process is the same between them. (And the lang one is not written as clearly.)
It is not uncommon that PRs are approved with the wrong version in them, and then there is confusion if it isn't caught, or triggers busywork for backports and such. It would be nice to be a little more careful about that.
Oh. Well, that would be because I didn't know the std dev guide existed, so looked in the wrong place 😥 I'll change this to just have a pointer to that, and send a PR over there with the examples. |
scottmcm
added
the
S-waiting-on-author
scottmcm
changed the title
scottmcm
force-pushed
the
library-stabilization
branch
from
0155119 to
6ccb6f0
Compare
scottmcm
added
S-waiting-on-review
|
Ok, I've re-done the update here. PR to std-dev-guide to happen in future. |
camelid
changed the title
|
Ping for a review here, please. rust-lang/std-dev-guide#32 is open to add good guidance there, so it'd be nice to help it be found. |
src/stabilization_guide.md
Outdated
| [the stabilization chapter of the std dev guide]: https://std-dev-guide.rust-lang.org/feature-lifecycle/stabilization.html | ||
| [the `src/version` file in `master`]: https://github.com/rust-lang/rust/blob/master/src/version | ||
| [the version schedule on the Forge]: https://forge.rust-lang.org/#current-release-versions | ||
| [the Friday before]: https://forge.rust-lang.org/release/process.html |
There was a problem hiding this comment.
These link reference names (e.g., the stabilization chapter of the std dev guide) are long and prone to breaking if wording is changed. Could you change them to be pithier?
E.g.: std-guide-stabilization, src-version, release-process.
(You'll have to add manual [...] link references to the text too.)
There was a problem hiding this comment.
Good idea. I've added pithy names to these, and added the (...) link references.
(The [...] was a typo, right? My syntax highlighter thinks this is right.)
There was a problem hiding this comment.
No, it should be [...]. For example, [look at this](src-version) will link to src-version as if it is a URL. On the other hand, [look at this][src-version] will use the URL value of the definition [src-version]: https://example.com as the link.
There was a problem hiding this comment.
Oh! I see; thank you. Fixed.
There was a problem hiding this comment.
And I checked the rendered https://github.com/rust-lang/rustc-dev-guide/blob/library-stabilization/src/stabilization_guide.md this time to confirm, which I should have done last time but didn't think of.
scottmcm
force-pushed
the
library-stabilization
branch
from
66629d6 to
5246a52
Compare
Also update the "which version" discussion with more details.
Co-authored-by: pierwill <[email protected]>
scottmcm
force-pushed
the
library-stabilization
branch
from
c62a528 to
649a302
Compare
Update books ## book 3 commits in 765318b844569a642ceef7bf1adab9639cbf6af3..de0dbffc5812fd885700874e8d258dd334733ac4 2022-04-12 21:14:47 -0400 to 2022-04-18 19:29:45 -0400 - Remove duplicate text - Add missing punctuation mark in ch16-01 - Update main.rs ## rust-by-example 1 commits in c2a98d9fc5d29c481d42052fbeccfde15ed03116..44a80e8d8bfc5881c9bd69a2cb3a570776ee4181 2022-04-08 06:44:18 -0300 to 2022-04-19 07:46:28 -0300 - Use rust 2018 module file hierarchy (rust-lang/rust-by-example#1532) ## rustc-dev-guide 6 commits in eeb5a83..043e60f 2022-04-11 23:29:48 +0900 to 2022-04-20 18:57:49 +0900 - Fix a small typo (rust-lang/rustc-dev-guide#1343) - Extend debugging llvm section (rust-lang/rustc-dev-guide#1290) - Send people doing *library* stabilizations over to the std-dev-guide (rust-lang/rustc-dev-guide#1317) - Fix typo serious->series (rust-lang/rustc-dev-guide#1336) - Minor type fix (rust-lang/rustc-dev-guide#1337) - sessiondiagnostic: translation (rust-lang/rustc-dev-guide#1333) ## embedded-book 3 commits in a6de8b6e3ea5d4f0de8b7b9a7e5c1405dc2c2ddb..f7cefbb995eec8c6148f213235e9e2e03268e775 2022-03-17 21:21:39 +0000 to 2022-04-20 10:38:51 +0000 - Fix use of unaligned references in example (rust-embedded/book#317) - Correct C interop declarations (rust-embedded/book#315) - Update index.md (rust-embedded/book#316)
Because sending people doing library stabilization to
feature_gate.rswill just result in confusion.