]> git.lizzy.rs Git - rust.git/commitdiff
add new section about CLI flags
authorQuietMisdreavus <grey@quietmisdreavus.net>
Thu, 15 Mar 2018 14:33:57 +0000 (09:33 -0500)
committerQuietMisdreavus <grey@quietmisdreavus.net>
Thu, 15 Mar 2018 14:35:22 +0000 (09:35 -0500)
src/doc/rustdoc/src/unstable-features.md

index 243d60737678381ea96ffddeb8704939e2ee3cca..837a55f371fb5bb1fc5018cde8c6e8e9e26da6d9 100644 (file)
@@ -196,3 +196,10 @@ chapter in the Unstable Book][unstable-include] and [its tracking issue][issue-i
 
 [unstable-include]: ../unstable-book/language-features/external-doc.html
 [issue-include]: https://github.com/rust-lang/rust/issues/44732
+
+## Unstable command-line arguments
+
+These features are enabled by passing a command-line flag to Rustdoc, but the flags in question are
+themselves marked as unstable. To use any of these options, pass `-Z unstable-options` as well as
+the flag in question to Rustdoc on the command-line. To do this from Cargo, you can either use the
+`RUSTDOCFLAGS` environment variable or the `cargo rustdoc` command.