summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorSmittyvb <me@smitop.com>2021-06-29 12:41:13 -0400
committerGitHub <noreply@github.com>2021-06-29 18:41:13 +0200
commit6ca1ad3d8a4225d28492c930d4704bf4210b6623 (patch)
tree9f946721f824919e7ed96c0ab145ffb61d3c1f2c /src/doc/rustc-dev-guide
parent602444c5b9472f66d34f76cd55939e8911c0becb (diff)
downloadrust-6ca1ad3d8a4225d28492c930d4704bf4210b6623.tar.gz
rust-6ca1ad3d8a4225d28492c930d4704bf4210b6623.zip
Document how to mark features as incomplete (#1151)
* Document how to mark features as incomplete

This was changed in https://github.com/rust-lang/rust/pull/86446 so that
incompleteness is included in the delcaration.

* Footerify link
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/feature-gates.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/feature-gates.md b/src/doc/rustc-dev-guide/src/feature-gates.md
index db6c72ff810..229281f2f0b 100644
--- a/src/doc/rustc-dev-guide/src/feature-gates.md
+++ b/src/doc/rustc-dev-guide/src/feature-gates.md
@@ -27,6 +27,14 @@ For example:
 (active, non_ascii_idents, "1.0.0", Some(55467), None),
 ```
 
+Features can be marked as incomplete, and trigger the warn-by-default [`incomplete_features` lint]
+by setting their type to `incomplete`:
+
+```rust,ignore
+/// Allows unsized rvalues at arguments and parameters.
+(incomplete, unsized_locals, "1.30.0", Some(48055), None),
+```
+
 When added, the current version should be the one for the current nightly.
 Once the feature is moved to `accepted.rs`, the version is changed to that
 nightly version.
@@ -99,4 +107,5 @@ updating the declaration!
 
 
 ["Stability in code"]: ./implementing_new_features.md#stability-in-code
+[`incomplete_features` lint]: https://doc.rust-lang.org/rustc/lints/listing/warn-by-default.html#incomplete-features
 ["Updating the feature-gate listing"]: ./stabilization_guide.md#updating-the-feature-gate-listing