Skip to content

Commit addcc8c

Browse files
authored
Update release information for home 0.5.11 (#14939)
This is in preparation to publish a new release of the home crate (from the current master branch).
2 parents e5c4dc6 + 20ec18a commit addcc8c

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

crates/home/CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## 0.5.11 - 2024-12-16
8+
9+
Note: 0.5.10 was not published.
10+
11+
- Updated package metadata.
12+
[#13184](https://github.com/rust-lang/cargo/pull/13184)
13+
- Updated minimum Rust version to 1.81.
14+
[#13266](https://github.com/rust-lang/cargo/pull/13266)
15+
[#13324](https://github.com/rust-lang/cargo/pull/13324)
16+
[#14871](https://github.com/rust-lang/cargo/pull/14871)
17+
- Updated windows-sys to 0.59.
18+
[#14335](https://github.com/rust-lang/cargo/pull/14335)
19+
- Clarified support level of this crate (not intended for external use).
20+
[#14600](https://github.com/rust-lang/cargo/pull/14600)
21+
- Docs cleanup.
22+
[#14823]()
23+
- Add notice that this crate should not be used, and to use the standard library's `home_dir` instead.
24+
[#14939](https://github.com/rust-lang/cargo/pull/14939)
25+
726
## 0.5.9 - 2023-12-15
827

928
- Replace SHGetFolderPathW with SHGetKnownFolderPath

crates/home/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,19 @@ This provides the definition of `home_dir` used by Cargo and rustup,
77
as well functions to find the correct value of `CARGO_HOME` and
88
`RUSTUP_HOME`.
99

10-
The definition of `home_dir` provided by the standard library is
10+
The definition of [`home_dir`] provided by the standard library is
1111
incorrect because it considers the `HOME` environment variable on
1212
Windows. This causes surprising situations where a Rust program will
1313
behave differently depending on whether it is run under a Unix
1414
emulation environment like Cygwin or MinGW. Neither Cargo nor rustup
1515
use the standard library's definition - they use the definition here.
1616

17+
**Note:** This has been fixed in Rust 1.85 to no longer use the `HOME`
18+
environment variable on Windows. If you are still using this crate for the
19+
purpose of getting a home directory, you are strongly encouraged to switch to
20+
using the standard library's [`home_dir`] instead. It is planned to have the
21+
deprecation notice removed in 1.86.
22+
1723
This crate further provides two functions, `cargo_home` and
1824
`rustup_home`, which are the canonical way to determine the location
1925
that Cargo and rustup store their data.
@@ -25,6 +31,7 @@ See [rust-lang/rust#43321].
2531
> crate may make major changes to its APIs or be deprecated without warning.
2632
2733
[rust-lang/rust#43321]: https://github.com/rust-lang/rust/issues/43321
34+
[`home_dir`]: https://doc.rust-lang.org/nightly/std/env/fn.home_dir.html
2835

2936
## License
3037

0 commit comments

Comments
 (0)