diff options
| -rw-r--r-- | src/libstd/env.rs | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/src/libstd/env.rs b/src/libstd/env.rs index 3447d1683a8..518c67bbe7f 100644 --- a/src/libstd/env.rs +++ b/src/libstd/env.rs @@ -416,7 +416,10 @@ impl Error for JoinPathsError { /// Returns the value of the 'HOME' environment variable if it is /// set and not equal to the empty string. Otherwise, returns the value of the /// 'USERPROFILE' environment variable if it is set and not equal to the empty -/// string. +/// string. If both do not exist, [`GetUserProfileDirectory`][msdn] is used to +/// return the appropriate path. +/// +/// [msdn]: https://msdn.microsoft.com/en-us/library/windows/desktop/bb762280(v=vs.85).aspx /// /// # Examples /// @@ -442,7 +445,11 @@ pub fn home_dir() -> Option<PathBuf> { /// /// On Windows, returns the value of, in order, the 'TMP', 'TEMP', /// 'USERPROFILE' environment variable if any are set and not the empty -/// string. Otherwise, tmpdir returns the path to the Windows directory. +/// string. Otherwise, tmpdir returns the path to the Windows directory. This +/// behavior is identical to that of [GetTempPath][msdn], which this function +/// uses internally. +/// +/// [msdn]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa364992(v=vs.85).aspx /// /// ``` /// use std::env; |