From ebb6ce33808d9b6391a23adc732dacce354e8561 Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Wed, 18 Mar 2015 19:49:39 -0400 Subject: [PATCH] Document include! Fixes #22309 --- src/libstd/macros.rs | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/libstd/macros.rs b/src/libstd/macros.rs index e1ef30627948d..f4a7e8b1b9824 100644 --- a/src/libstd/macros.rs +++ b/src/libstd/macros.rs @@ -404,4 +404,18 @@ pub mod builtin { /// ``` #[macro_export] macro_rules! cfg { ($cfg:tt) => ({ /* compiler built-in */ }) } + + /// Parse the current given file as an expression. + /// + /// This is generally a bad idea, because it's going to behave unhygenically. + /// + /// # Examples + /// + /// ```ignore + /// fn foo() { + /// include!("/path/to/a/file") + /// } + /// ``` + #[macro_export] + macro_rules! include { ($cfg:tt) => ({ /* compiler built-in */ }) } }