about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorMazdak Farrokhzad <twingoow@gmail.com>2019-11-30 06:43:32 +0100
committerMazdak Farrokhzad <twingoow@gmail.com>2019-11-30 06:43:32 +0100
commit91fcd40ca2637796b5b4eb75db7cfb57efcde11e (patch)
tree33afd0437add041ca276928a23cf72a9cf4e7f6c /src
parentb756b7d074976c3644031009e89925963ce6f798 (diff)
downloadrust-91fcd40ca2637796b5b4eb75db7cfb57efcde11e.tar.gz
rust-91fcd40ca2637796b5b4eb75db7cfb57efcde11e.zip
update rustc_feature crate docs
Diffstat (limited to 'src')
-rw-r--r--src/librustc_feature/lib.rs14
1 files changed, 6 insertions, 8 deletions
diff --git a/src/librustc_feature/lib.rs b/src/librustc_feature/lib.rs
index e8ed1f377e5..82e60889316 100644
--- a/src/librustc_feature/lib.rs
+++ b/src/librustc_feature/lib.rs
@@ -1,16 +1,14 @@
-//! # Feature gating
+//! # Feature gates
 //!
-//! This module implements the gating necessary for preventing certain compiler
-//! features from being used by default. This module will crawl a pre-expanded
-//! AST to ensure that there are no features which are used that are not
-//! enabled.
+//! This crate declares the set of past and present unstable features in the compiler.
+//! Feature gate checking itself is done in `libsyntax/feature_gate/check.rs` at the moment.
 //!
 //! Features are enabled in programs via the crate-level attributes of
 //! `#![feature(...)]` with a comma-separated list of features.
 //!
-//! For the purpose of future feature-tracking, once code for detection of feature
-//! gate usage is added, *do not remove it again* even once the feature
-//! becomes stable.
+//! For the purpose of future feature-tracking, once a feature gate is added,
+//! even if it is stabilized or removed, *do not remove it*. Instead, move the
+//! symbol to the `accepted` or `removed` modules respectively.
 
 mod accepted;
 mod removed;