Skip to content

Commit

Permalink
Clarify the behavior of std::env::home_dir and std::env::temp_dir
Browse files Browse the repository at this point in the history
This concern was raised by #28940.
  • Loading branch information
barosl committed Oct 11, 2015
1 parent 9d3e79a commit 8667aa2
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions src/libstd/env.rs
Expand Up @@ -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
///
Expand All @@ -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;
Expand Down

0 comments on commit 8667aa2

Please sign in to comment.