Better documentation for env::home_dir()'s broken behaviour#101648

Timmmm · 2022-09-10T11:44:05Z

This improves the documentation to say why it was deprecated. The reason was because it reads HOME on Windows which is meaningless there. Note that the PR that deprecated it stated that returning an empty string if HOME is set to an empty string was a problem, however I can find no evidence that this is the case. cd handles it fine whereas if HOME is unset it gives an explicit HOME not set error.

Original deprecation reason: https://internals.rust-lang.org/t/deprecate-or-break-fix-std-env-home-dir/7315
Original deprecation PR: Deprecate std::env::home_dir and fix incorrect documentation #51656

See #71684

This improves the documentation to say *why* it was deprecated. The reason was because it reads `HOME` on Windows which is meaningless there. Note that the PR that deprecated it stated that returning an empty string if `HOME` is set to an empty string was a problem, however I can find no evidence that this is the case. `cd` handles it fine whereas if `HOME` is unset it gives an explicit `HOME not set` error. * Original deprecation reason: https://internals.rust-lang.org/t/deprecate-or-break-fix-std-env-home-dir/7315 * Original deprecation PR: rust-lang#51656 See rust-lang#71684

rustbot · 2022-09-10T11:44:07Z

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

Stabilizing library features
Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
Changing public documentation in ways that create new stability guarantees
Changing observable runtime behavior of library APIs

rust-highfive · 2022-09-10T11:44:08Z

r? @joshtriplett

(rust-highfive has picked a reviewer for you, use r? to override)

library/std/src/env.rs

joshtriplett · 2022-10-03T12:08:48Z

Posted a suggestion with a rephrasing. Otherwise LGTM; 👍 for explaining the deprecation.

r=me with the suggestion (or something similar) applied.

Co-authored-by: Josh Triplett <josh@joshtriplett.org>

Dylan-DPC · 2022-12-11T10:42:59Z

@bors r=joshtriplett

bors · 2022-12-11T10:43:01Z

📌 Commit 8f0025e has been approved by joshtriplett

It is now in the queue for this repository.

matthiaskrgr · 2022-12-11T11:31:10Z

@bors rollup=always

Better documentation for env::home_dir()'s broken behaviour This improves the documentation to say *why* it was deprecated. The reason was because it reads `HOME` on Windows which is meaningless there. Note that the PR that deprecated it stated that returning an empty string if `HOME` is set to an empty string was a problem, however I can find no evidence that this is the case. `cd` handles it fine whereas if `HOME` is unset it gives an explicit `HOME not set` error. * Original deprecation reason: https://internals.rust-lang.org/t/deprecate-or-break-fix-std-env-home-dir/7315 * Original deprecation PR: rust-lang#51656 See rust-lang#71684

…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#101648 (Better documentation for env::home_dir()'s broken behaviour) - rust-lang#105283 (Don't call `diagnostic_hir_wf_check` query if we have infer variables) - rust-lang#105369 (Detect spurious ; before assoc fn body) - rust-lang#105472 (Make encode_info_for_trait_item use queries instead of accessing the HIR) - rust-lang#105521 (separate heading from body) - rust-lang#105555 (llvm-wrapper: adapt for LLVM API changes) - rust-lang#105560 (Extend rustdoc hashtag prepended line test) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Sep 10, 2022

rust-highfive assigned joshtriplett Sep 10, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 10, 2022

jfrimmel reviewed Sep 10, 2022

View reviewed changes

library/std/src/env.rs Show resolved Hide resolved

joshtriplett reviewed Oct 3, 2022

View reviewed changes

library/std/src/env.rs Outdated Show resolved Hide resolved

joshtriplett added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 3, 2022

Reword "has no meaning" per suggestion

8f0025e

Co-authored-by: Josh Triplett <josh@joshtriplett.org>

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 11, 2022

Dylan-DPC mentioned this pull request Dec 11, 2022

Rollup of 6 pull requests #105565

Closed

matthiaskrgr mentioned this pull request Dec 11, 2022

Rollup of 7 pull requests #105579

Merged

bors merged commit 668976b into rust-lang:master Dec 12, 2022

rustbot added this to the 1.68.0 milestone Dec 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Better documentation for env::home_dir()'s broken behaviour#101648