itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-25 11:14:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify status of home_dir

Browse Source 
Users should be using the standard library `home_dir` instead of this
crate.
This commit is contained in:
Eric Huss 2024-12-15 14:20:56 -08:00
parent 769f622e12
commit 014378f8c0
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
crates/home/README.md
View File

@ -7,13 +7,19 @@ This provides the definition of `home_dir` used by Cargo and rustup,
as well functions to find the correct value of `CARGO_HOME` and
`RUSTUP_HOME`.
The definition of `home_dir` provided by the standard library is
The definition of [`home_dir`] provided by the standard library is
incorrect because it considers the `HOME` environment variable on
Windows. This causes surprising situations where a Rust program will
behave differently depending on whether it is run under a Unix
emulation environment like Cygwin or MinGW. Neither Cargo nor rustup
use the standard library's definition - they use the definition here.
**Note:** This has been fixed in Rust 1.85 to no longer use the `HOME`
environment variable on Windows. If you are still using this crate for the
purpose of getting a home directory, you are strongly encouraged to switch to
using the standard library's [`home_dir`] instead. It is planned to have the
deprecation notice removed in 1.86.
This crate further provides two functions, `cargo_home` and
`rustup_home`, which are the canonical way to determine the location
that Cargo and rustup store their data.
@ -25,6 +31,7 @@ See [rust-lang/rust#43321].
> crate may make major changes to its APIs or be deprecated without warning.
[rust-lang/rust#43321]: https://github.com/rust-lang/rust/issues/43321
[`home_dir`]: https://doc.rust-lang.org/nightly/std/env/fn.home_dir.html
## License