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

Add doc alias for chdir to std::env::set_current_dir #84709

Merged
merged 1 commit into from
May 5, 2021

Conversation

joshtriplett
Copy link
Member

Searching for chdir in the Rust documentation produces no useful
results.

I wrote some code recently that called libc::chdir and manually
handled errors, because I didn't realize that the safe
std::env::set_current_dir existed. I searched for chdir and
change_dir and change_directory (the latter two based on the
precedent of unabbreviating set by create_dir), and I also read
through std::fs expecting to potentially find it there. Given that
none of those led to std::env::set_current_dir, I think that provides
sufficient justification to add this specific alias.

Searching for `chdir` in the Rust documentation produces no useful
results.
@rust-highfive
Copy link
Collaborator

r? @dtolnay

(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 Apr 29, 2021
Copy link
Member

@dtolnay dtolnay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me. Thanks!

@dtolnay
Copy link
Member

dtolnay commented May 4, 2021

@bors r+ rollup

@bors
Copy link
Contributor

bors commented May 4, 2021

📌 Commit c185f08 has been approved by dtolnay

@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-review Status: Awaiting review from the assignee but also interested parties. labels May 4, 2021
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request May 4, 2021
…lnay

Add doc alias for `chdir` to `std::env::set_current_dir`

Searching for `chdir` in the Rust documentation produces no useful
results.

I wrote some code recently that called `libc::chdir` and manually
handled errors, because I didn't realize that the safe
`std::env::set_current_dir` existed. I searched for `chdir` and
`change_dir` and `change_directory` (the latter two based on the
precedent of unabbreviating set by `create_dir`), and I also read
through `std::fs` expecting to potentially find it there. Given that
none of those led to `std::env::set_current_dir`, I think that provides
sufficient justification to add this specific alias.
RalfJung added a commit to RalfJung/rust that referenced this pull request May 5, 2021
…lnay

Add doc alias for `chdir` to `std::env::set_current_dir`

Searching for `chdir` in the Rust documentation produces no useful
results.

I wrote some code recently that called `libc::chdir` and manually
handled errors, because I didn't realize that the safe
`std::env::set_current_dir` existed. I searched for `chdir` and
`change_dir` and `change_directory` (the latter two based on the
precedent of unabbreviating set by `create_dir`), and I also read
through `std::fs` expecting to potentially find it there. Given that
none of those led to `std::env::set_current_dir`, I think that provides
sufficient justification to add this specific alias.
RalfJung added a commit to RalfJung/rust that referenced this pull request May 5, 2021
…lnay

Add doc alias for `chdir` to `std::env::set_current_dir`

Searching for `chdir` in the Rust documentation produces no useful
results.

I wrote some code recently that called `libc::chdir` and manually
handled errors, because I didn't realize that the safe
`std::env::set_current_dir` existed. I searched for `chdir` and
`change_dir` and `change_directory` (the latter two based on the
precedent of unabbreviating set by `create_dir`), and I also read
through `std::fs` expecting to potentially find it there. Given that
none of those led to `std::env::set_current_dir`, I think that provides
sufficient justification to add this specific alias.
bors added a commit to rust-lang-ci/rust that referenced this pull request May 5, 2021
Rollup of 11 pull requests

Successful merges:

 - rust-lang#83553 (Update `ptr` docs with regards to `ptr::addr_of!`)
 - rust-lang#84183 (Update RELEASES.md for 1.52.0)
 - rust-lang#84709 (Add doc alias for `chdir` to `std::env::set_current_dir`)
 - rust-lang#84803 (Reduce duplication in `impl_dep_tracking_hash` macros)
 - rust-lang#84808 (Account for unsatisfied bounds in E0599)
 - rust-lang#84843 (use else if in std library )
 - rust-lang#84865 (rustbuild: Pass a `threads` flag that works to windows-gnu lld)
 - rust-lang#84878 (Clarify documentation for `[T]::contains`)
 - rust-lang#84882 (platform-support: Center the contents of the `std` and `host` columns)
 - rust-lang#84903 (Remove `rustc_middle::mir::interpret::CheckInAllocMsg::NullPointerTest`)
 - rust-lang#84913 (Do not ICE on invalid const param)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 4c4b3e8 into rust-lang:master May 5, 2021
@rustbot rustbot added this to the 1.54.0 milestone May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants