about summary refs log tree commit diff
path: root/src/doc/rustdoc
diff options
context:
space:
mode:
authorQuietMisdreavus <grey@quietmisdreavus.net>2018-03-12 17:16:21 -0500
committerQuietMisdreavus <grey@quietmisdreavus.net>2018-03-12 17:16:21 -0500
commitc685b57bf27d3ddecd83ab77e1973d36dff755b4 (patch)
tree197164f6a4dd118d48468fa07db8f98f4651ccb9 /src/doc/rustdoc
parent883e74645d350b6752cb94d48f46363f6f8789e9 (diff)
downloadrust-c685b57bf27d3ddecd83ab77e1973d36dff755b4.tar.gz
rust-c685b57bf27d3ddecd83ab77e1973d36dff755b4.zip
add page to the Rustdoc Book about unstable features
Diffstat (limited to 'src/doc/rustdoc')
-rw-r--r--src/doc/rustdoc/src/SUMMARY.md1
-rw-r--r--src/doc/rustdoc/src/unstable-features.md10
2 files changed, 11 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/SUMMARY.md b/src/doc/rustdoc/src/SUMMARY.md
index 6315cb81a84..46528187c11 100644
--- a/src/doc/rustdoc/src/SUMMARY.md
+++ b/src/doc/rustdoc/src/SUMMARY.md
@@ -5,3 +5,4 @@
 - [The `#[doc]` attribute](the-doc-attribute.md)
 - [Documentation tests](documentation-tests.md)
 - [Passes](passes.md)
+- [Unstable features](unstable-features.md)
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md
new file mode 100644
index 00000000000..35380cdf069
--- /dev/null
+++ b/src/doc/rustdoc/src/unstable-features.md
@@ -0,0 +1,10 @@
+# Unstable features
+
+Rustdoc is under active developement, and like the Rust compiler, some features are only available
+on the nightly releases. Some of these are new and need some more testing before they're able to get
+released to the world at large, and some of them are tied to features in the Rust compiler that are
+themselves unstable. Several features here require a matching `#![feature(...)]` attribute to
+enable, and thus are more fully documented in the [Unstable Book]. Those sections will link over
+there as necessary.
+
+[Unstable Book]: ../unstable-book/