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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 2 commits into from
Dec 12, 2022
Merged

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

merged 2 commits into from
Dec 12, 2022

Conversation

Timmmm
Copy link
Contributor

@Timmmm Timmmm commented Sep 10, 2022

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.

See #71684

@Timmmm
Better documentation for env::home_dir()'s broken behaviour
8d08983 
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
Copy link
Collaborator

rustbot commented Sep 10, 2022

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

@rustbot 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
Copy link
Collaborator

r? @joshtriplett

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

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 10, 2022
joshtriplett
joshtriplett reviewed Oct 3, 2022
View reviewed changes
library/std/src/env.rs Outdated Show resolved Hide resolved
@joshtriplett
Copy link
Member

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

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

@joshtriplett 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
@Dylan-DPC
Copy link
Member

@bors r=joshtriplett

@bors
Copy link
Contributor

bors commented Dec 11, 2022

📌 Commit 8f0025e has been approved by joshtriplett

It is now in the queue for this repository.

@bors 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
@matthiaskrgr
Copy link
Member

@bors rollup=always

Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Dec 11, 2022
@Dylan-DPC
Rollup merge of rust-lang#101648 - Timmmm:home_dir_docs, r=joshtriplett
59fde0b 
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
@Dylan-DPC Dylan-DPC mentioned this pull request Dec 11, 2022
Closed
@matthiaskrgr matthiaskrgr mentioned this pull request Dec 11, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 11, 2022
@bors
Auto merge of rust-lang#105579 - matthiaskrgr:rollup-vw5dlqc, r=matth…
ee6533d 
…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
@bors bors merged commit 668976b into rust-lang:master Dec 12, 2022
@rustbot rustbot added this to the 1.68.0 milestone Dec 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jfrimmel jfrimmel jfrimmel left review comments

@joshtriplett joshtriplett joshtriplett left review comments

Assignees

@joshtriplett joshtriplett

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.68.0
Development

Successfully merging this pull request may close these issues.
8 participants
@Timmmm @rustbot @rust-highfive @joshtriplett @Dylan-DPC @bors @matthiaskrgr @jfrimmel