about summary refs log tree commit diff
path: root/src/doc/reference.md
diff options
context:
space:
mode:
authorHuon Wilson <dbau.pp+github@gmail.com>2015-03-02 21:46:31 +1100
committerHuon Wilson <dbau.pp+github@gmail.com>2015-03-03 13:00:10 +1100
commitc195783c05d253c8e32fb781cce1ae978f8bd6bd (patch)
tree1a07800240ff1a16cceada0879260e839b286c51 /src/doc/reference.md
parent157614249594f187f421cd97f928e64c5ab5c1fa (diff)
downloadrust-c195783c05d253c8e32fb781cce1ae978f8bd6bd.tar.gz
rust-c195783c05d253c8e32fb781cce1ae978f8bd6bd.zip
Feature gate `#[static_assert]`.
The API this exposes is a little strange (being attached to `static`s),
so it makes sense to conservatively feature gate it. If it is highly
popular, it is possible to reverse this gating.
Diffstat (limited to 'src/doc/reference.md')
-rw-r--r--src/doc/reference.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md
index 2f047d2c173..333d6fddbbd 100644
--- a/src/doc/reference.md
+++ b/src/doc/reference.md
@@ -2495,6 +2495,12 @@ The currently implemented features of the reference compiler are:
 
 * `staged_api` - Allows usage of stability markers and `#![staged_api]` in a crate
 
+* `static_assert` - The `#[static_assert]` functionality is experimental and
+                    unstable. The attribute can be attached to a `static` of
+                    type `bool` and the compiler will error if the `bool` is
+                    `false` at compile time. This version of this functionality
+                    is unintuitive and suboptimal.
+
 * `start` - Allows use of the `#[start]` attribute, which changes the entry point
             into a Rust program. This capabiilty, especially the signature for the
             annotated function, is subject to change.