Rollup merge of #101648 - Timmmm:home_dir_docs, r=joshtriplett

[rust.git] / library / std / src / env.rs

diff --git a/library/std/src/env.rs b/library/std/src/env.rs
index 6eb7cbea6269d7c92531fe00f1cb6a7edccb7f26..183f9ab3b08f632a2a945bd905be038571a125a9 100644 (file)
--- a/library/std/src/env.rs
+++ b/library/std/src/env.rs
@@ -570,6 +570,13 @@ fn description(&self) -> &str {
 ///
 /// [msdn]: https://docs.microsoft.com/en-us/windows/win32/api/userenv/nf-userenv-getuserprofiledirectorya
 ///
+/// # Deprecation
+///
+/// This function is deprecated because the behaviour on Windows is not correct.
+/// The 'HOME' environment variable is not standard on Windows, and may not produce
+/// desired results; for instance, under Cygwin or Mingw it will return `/home/you`
+/// when it should return `C:\Users\you`.
+///
 /// # Examples
 ///
 /// ```
@@ -582,7 +589,7 @@ fn description(&self) -> &str {
 /// ```
 #[deprecated(
     since = "1.29.0",
-    note = "This function's behavior is unexpected and probably not what you want. \
+    note = "This function's behavior may be unexpected on Windows. \
             Consider using a crate from crates.io instead."
 )]
 #[must_use]