-
Notifications
You must be signed in to change notification settings - Fork 546
Document how to modify feature gates #968
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
Merged
Merged
Changes from 1 commit
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
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 |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Feature Gates | ||
|
||
This chapter is intended to provide basic help for modifying feature gates. See | ||
["Stability in code"][stability-section] for help with *adding* feature gates. | ||
|
||
[stability-section]: ./implementing_new_features.md#stability-in-code | ||
|
||
|
||
## Removing a feature gate | ||
|
||
[removing]: #removing-a-feature-gate | ||
|
||
To remove a feature gate, follow these steps: | ||
|
||
1. Remove the feature gate declaration in `rustc_feature/src/active.rs`. | ||
It will look like this: | ||
|
||
```rust,ignore | ||
/// description of feature | ||
(active, $feature_name, "$version", Some($tracking_issue_number), $edition) | ||
``` | ||
|
||
2. Add a modified version of the feature gate declaration that you just | ||
removed to `rustc_feature/src/removed.rs`: | ||
|
||
```rust,ignore | ||
/// description of feature | ||
(removed, $old_feature_name, "$version", Some($tracking_issue_number), $edition, | ||
Some("$why_it_was_removed")) | ||
``` | ||
|
||
|
||
## Renaming a feature gate | ||
|
||
[renaming]: #renaming-a-feature-gate | ||
|
||
To rename a feature gate, follow these steps (the first two are the same steps | ||
to follow when [removing a feature gate][removing]): | ||
|
||
1. Remove the old feature gate declaration in `rustc_feature/src/active.rs`. | ||
It will look like this: | ||
|
||
```rust,ignore | ||
/// description of feature | ||
(active, $old_feature_name, "$version", Some($tracking_issue_number), $edition) | ||
``` | ||
|
||
2. Add a modified version of the old feature gate declaration that you just | ||
removed to `rustc_feature/src/removed.rs`: | ||
|
||
```rust,ignore | ||
/// description of feature | ||
/// Renamed to `$new_feature_name` | ||
(removed, $old_feature_name, "$version", Some($tracking_issue_number), $edition, | ||
Some("renamed to `$new_feature_name`")) | ||
``` | ||
|
||
3. Add a feature gate declaration with the new name to | ||
`rustc_feature/src/active.rs`. It should look very similar to the old | ||
declaration: | ||
|
||
```rust,ignore | ||
/// description of feature | ||
(active, $new_feature_name, "$version", Some($tracking_issue_number), $edition) | ||
``` |
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.
Uh oh!
There was an error while loading. Please reload this page.