Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update RELEASES.md with missing deprecation notes. #84914

Closed
wants to merge 1 commit into from

Conversation

CDirkx
Copy link
Contributor

@CDirkx CDirkx commented May 4, 2021

Adds the following missing deprecation notes for the 1.52.0 release:

@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive
Copy link
Collaborator

⚠️ Warning ⚠️

  • Pull requests are usually filed against the master branch for this repo, but this one is against stable. Please double check that you specified the right target!

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 4, 2021
@CDirkx
Copy link
Contributor Author

CDirkx commented May 4, 2021

I don't know how complete the compatibility notes section is supposed to be, if any of these were intentionally omitted let me know.
Also this PR is against stable, is that the correct procedure? Or should I wait until master has the 1.52.0 release notes.

@Mark-Simulacrum
Copy link
Member

cc @pietroalbini @XAMPPRocky

It probably makes sense to target master for this PR, as we try to keep the stable branch updated to the release and not some delta thereof. I don't think we expect to rebuild artifacts at this point.

I don't think compat notes is the right section for this, though, as these aren't breaking changes or even changes users should expect to need to change away from, just that it may be desirable. I don't think we generally include notes on all deprecations.

@@ -97,6 +97,9 @@ Compatibility Notes
- [Rustc now catches more cases of `pub_use_of_private_extern_crate`][80763]
- [Changes in how proc macros handle whitespace may lead to panics when used
with older `proc-macro-hack` versions. A `cargo update` should be sufficient to fix this in all cases.][84136]
- [Deprecated internal compiler derive macros `RustcEncodable` and `RustcDecodable`.][83160]
- [Deprecated `alloc::LayoutErr` in favor of `alloc::LayoutError`.][81767]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#81767 is the PR that adjusted the deprecation since to 1.52.0, but it might be more informative to link to #77691 which includes the FCP.

@CDirkx
Copy link
Contributor Author

CDirkx commented May 4, 2021

I looked through the earlier compatibility notes, sometimes deprecation is mentioned under "compatibility notes", sometimes under "library", and indeed most of the time not at all. The deprecations that are mentioned are generally changes that affect a large number of users, such as mem::uninitialized or Error::cause, so I don't think the changes in this PR qualify.

@Mark-Simulacrum
Copy link
Member

Yeah, I think I'm going to go ahead and give this a close. I don't think these deprecations necessarily qualify and any affected users will directly be told by the compiler regardless.

@Mark-Simulacrum
Copy link
Member

Thanks!

@XAMPPRocky
Copy link
Member

XAMPPRocky commented May 4, 2021

I don't have an opinion on their inclusion. Though I do think we should try and occasionally remind people about the relnotes tag, because I bet some of these missing come from people forgetting or just not knowing about it.

@CDirkx Thank you for your PR!

@CDirkx CDirkx deleted the releases branch May 4, 2021 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants