-
Notifications
You must be signed in to change notification settings - Fork 554
Fix outdated feature gating examples in stabilization guide (fixes #2401) #2552
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -79,25 +79,25 @@ Also, remove those strings from any tests (e.g. under `tests/`). If there are te | |
Most importantly, remove the code which flags an error if the feature-gate is not present (since the feature is now considered stable). If the feature can be detected because it employs some new syntax, then a common place for that code to be is in `compiler/rustc_ast_passes/src/feature_gate.rs`. For example, you might see code like this: | ||
|
||
```rust,ignore | ||
gate_all!(pub_restricted, "`pub(restricted)` syntax is experimental"); | ||
gate_feature_post!(box_patterns, span, "box pattern syntax is experimental"); | ||
``` | ||
|
||
This `gate_feature_post!` macro prints an error if the `pub_restricted` feature is not enabled. It is not needed now that `#[pub_restricted]` is stable. | ||
This `gate_feature_post!` macro prints an error if the `box_patterns` feature is not enabled. It would not be needed once box pattern syntax becomes stable. | ||
|
||
For more subtle features, you may find code like this: | ||
|
||
```rust,ignore | ||
if self.tcx.features().async_fn_in_dyn_trait() { /* XXX */ } | ||
if self.tcx.features().box_patterns() { /* XXX */ } | ||
``` | ||
|
||
This `pub_restricted` field (named after the feature) would ordinarily be false if the feature flag is not present and true if it is. So transform the code to assume that the field is true. In this case, that would mean removing the `if` and leaving just the `/* XXX */`. | ||
This `box_patterns` field (named after the feature) would ordinarily be false if the feature flag is not present and true if it is. So transform the code to assume that the field is true. In this case, that would mean removing the `if` and leaving just the `/* XXX */`. | ||
|
||
```rust,ignore | ||
if self.tcx.sess.features.borrow().pub_restricted { /* XXX */ } | ||
if self.tcx.sess.features.borrow().box_patterns { /* XXX */ } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is also wrong. |
||
becomes | ||
/* XXX */ | ||
|
||
if self.tcx.sess.features.borrow().pub_restricted && something { /* XXX */ } | ||
if self.tcx.sess.features.borrow().box_patterns && something { /* XXX */ } | ||
becomes | ||
if something { /* XXX */ } | ||
``` | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is what the original issue was about, that this is no longer a thing.