about summary refs log tree commit diff
path: root/src/libproc_macro
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2017-01-01 20:33:37 -0500
committerSteve Klabnik <steve@steveklabnik.com>2017-01-04 17:34:30 -0500
commit3075c1f65e08e0b52dcf872588358daffef8b47c (patch)
treea758e97393d42ab3bd91b030dc16cce398adf56f /src/libproc_macro
parent95b14a3b50782a3f680ab3bc75dde813333cb708 (diff)
downloadrust-3075c1f65e08e0b52dcf872588358daffef8b47c.tar.gz
rust-3075c1f65e08e0b52dcf872588358daffef8b47c.zip
Document custom derive.
These are some bare-bones documentation for custom derive, needed
to stabilize "macros 1.1",
https://github.com/rust-lang/rust/issues/35900

The book chapter is based off of a blog post by @cbreeden,
https://cbreeden.github.io/Macros11/

Normally, we have a policy of not mentioning external crates in
documentation. However, given that syn/quote are basically neccesary
for properly using macros 1.1, I feel that not including them here
would make the documentation very bad. So the rules should be bent
in this instance.
Diffstat (limited to 'src/libproc_macro')
-rw-r--r--src/libproc_macro/lib.rs6
1 files changed, 2 insertions, 4 deletions
diff --git a/src/libproc_macro/lib.rs b/src/libproc_macro/lib.rs
index 1491bdc6c8d..22b365fa64f 100644
--- a/src/libproc_macro/lib.rs
+++ b/src/libproc_macro/lib.rs
@@ -15,15 +15,13 @@
 //! Currently the primary use of this crate is to provide the ability to define
 //! new custom derive modes through `#[proc_macro_derive]`.
 //!
-//! Added recently as part of [RFC 1681] this crate is stable as of Rust 1.15.0.
-//!
-//! [RFC 1681]: https://github.com/rust-lang/rfcs/blob/master/text/1681-macros-1.1.md
-//!
 //! Note that this crate is intentionally very bare-bones currently. The main
 //! type, `TokenStream`, only supports `fmt::Display` and `FromStr`
 //! implementations, indicating that it can only go to and come from a string.
 //! This functionality is intended to be expanded over time as more surface
 //! area for macro authors is stabilized.
+//!
+//! See [the book](../../book/procedural-macros.html) for more.
 
 #![crate_name = "proc_macro"]
 #![stable(feature = "proc_macro_lib", since = "1.15.0")]