Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking issue for release notes of #132515: Fix and undeprecate home_dir() #132650

Closed
1 of 3 tasks
rustbot opened this issue Nov 5, 2024 · 2 comments
Closed
1 of 3 tasks
Labels
O-windows Operating system: Windows relnotes Marks issues that should be documented in the release notes of the next release. relnotes-tracking-issue Marks issues tracking what text to put in release notes. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Milestone

Comments

@rustbot
Copy link
Collaborator

rustbot commented Nov 5, 2024

This issue tracks the release notes text for #132515.

Steps

  • Proposed text is drafted by PR author (or team) making the noteworthy change.
  • Issue is nominated for release team review of clarity for wider audience.
  • Release team includes text in release notes/blog posts.

Release notes text

The responsible team for the underlying change should edit this section to replace the automatically generated link with a succinct description of what changed, drawing upon text proposed by the author (either in discussion or through direct editing).

# Libraries
- [`std::env::home_dir()` on Windows now ignores the non-standard `$HOME` environment variable](https://github.com/rust-lang/rust/pull/132515)
   It will be un-deprecated in a subsequent release.

# Compatibility Notes
- `std::env::home_dir()` has been deprecated for years, because it can give surprising results in some Windows configurations if the `HOME` environment variable is set (which is not the normal configuration on Windows). We had previously avoided changing its behavior, out of concern for compatibility with code depending on this non-standard configuration. Given how long this function has been deprecated, we're now fixing its behavior as a bugfix. A subsequent release will remove the deprecation for this function.

Tip

Use the previous releases categories to help choose which one(s) to use.
The category will be de-duplicated with all the other ones by the release team.

More than one section can be included if needed.

Release blog section

If the change is notable enough for inclusion in the blog post, the responsible team should add content to this section.
Otherwise leave it empty.

`std::env::home_dir()` has been deprecated for years, because it can give surprising results in some Windows configurations if the `HOME` environment variable is set (which is not the normal configuration on Windows). We had previously changed its behavior, out of concern for compatibility with code depending on this non-standard configuration. Given how long this function has been deprecated, we're now fixing its behavior as a bugfix, and the next version will undeprecate it. (We deferred undeprecating it on nightly until today's stable release, to avoid potential confusion between the fixed version on nightly and the previously unfixed version on stable.)

cc @kornelski, @jhpratt -- origin issue/PR authors and assignees for starting to draft text

@rustbot rustbot added O-windows Operating system: Windows relnotes Marks issues that should be documented in the release notes of the next release. relnotes-tracking-issue Marks issues tracking what text to put in release notes. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Nov 5, 2024
@saethlin saethlin removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Nov 5, 2024
@kornelski
Copy link
Contributor

For release notes:

home_dir() stopped using HOME environment variable on Windows, which was a non-standard behavior. It will be undeprecated in the next release.

@rustbot rustbot added this to the 1.85.0 milestone Nov 30, 2024
@cuviper
Copy link
Member

cuviper commented Jan 20, 2025

We had previously changed its behavior, out of concern for compatibility

Is this meant to be "previously avoided changing its behavior"?

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 2, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
tgross35 added a commit to tgross35/rust that referenced this issue Mar 2, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
jhpratt added a commit to jhpratt/rust that referenced this issue Mar 4, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
tgross35 added a commit to tgross35/rust that referenced this issue Mar 4, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
jieyouxu added a commit to jieyouxu/rust that referenced this issue Mar 4, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
workingjubilee added a commit to workingjubilee/rustc that referenced this issue Mar 4, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
workingjubilee added a commit to workingjubilee/rustc that referenced this issue Mar 5, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
workingjubilee added a commit to workingjubilee/rustc that referenced this issue Mar 5, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
jieyouxu added a commit to jieyouxu/rust that referenced this issue Mar 5, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
jieyouxu added a commit to jieyouxu/rust that referenced this issue Mar 5, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
jieyouxu added a commit to jieyouxu/rust that referenced this issue Mar 5, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
compiler-errors added a commit to compiler-errors/rust that referenced this issue Mar 6, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
Noratrieb added a commit to Noratrieb/rust that referenced this issue Mar 6, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
compiler-errors added a commit to compiler-errors/rust that referenced this issue Mar 6, 2025
Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Mar 7, 2025
Rollup merge of rust-lang#137327 - arlosi:home-dir, r=Mark-Simulacrum

Undeprecate env::home_dir

rust-lang#132515 fixed the implementation of `env::home_dir`, but didn't remove the deprecation.

Based on [this comment](rust-lang#132515 (comment)), libs-api decided to undeprecate in the next release. Let's do that!

cc rust-lang#132650
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
O-windows Operating system: Windows relnotes Marks issues that should be documented in the release notes of the next release. relnotes-tracking-issue Marks issues tracking what text to put in release notes. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

5 participants