about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2014-09-16 13:51:01 -0700
committerBrian Anderson <banderson@mozilla.com>2014-09-16 13:51:01 -0700
commit474d34043e12b3a81f47c3709beff14e80088e55 (patch)
tree80578009485060ccab4402739c073a238f481876 /src/libstd
parent4bb4a43917bf702fb2c6a614786aa1abe6c1014c (diff)
downloadrust-474d34043e12b3a81f47c3709beff14e80088e55.tar.gz
rust-474d34043e12b3a81f47c3709beff14e80088e55.zip
Use PATH instead of HOME in env! example
HOME does not exist under typical windows environments.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/macros.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/libstd/macros.rs b/src/libstd/macros.rs
index 85e614ab47e..810d0e73ff3 100644
--- a/src/libstd/macros.rs
+++ b/src/libstd/macros.rs
@@ -434,8 +434,8 @@ pub mod builtin {
     /// # Example
     ///
     /// ```rust
-    /// let home: &'static str = env!("HOME");
-    /// println!("the home directory at the time of compiling was: {}", home);
+    /// let path: &'static str = env!("PATH");
+    /// println!("the $PATH variable at the time of compiling was: {}", path);
     /// ```
     #[macro_export]
     macro_rules! env( ($name:expr) => ({ /* compiler built-in */ }) )