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

Document Linux kernel handoff in std::io::copy and std::fs::copy #95294

Merged
merged 2 commits into from
Mar 30, 2022

Conversation

sourcefrog
Copy link
Contributor

No description provided.

@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 Mar 25, 2022
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.

I agree that there should be some indication here that these descriptions fall under the set of caveats explained in std::io's "Platform-specific behavior" documentation.

Either like this:

/// This function [currently] corresponds to the `getcwd` function on Unix
/// and the `GetCurrentDirectoryW` function on Windows.
///
/// [currently]: crate::io#platform-specific-behavior

or like this:

rust/library/std/src/fs.rs

Lines 545 to 549 in ee915c3

/// This function currently corresponds to the `fchmod` function on Unix and
/// the `SetFileInformationByHandle` function on Windows. Note that, this
/// [may change in the future][changes].
///
/// [changes]: io#platform-specific-behavior

@sourcefrog
Copy link
Contributor Author

OK will do.

@dtolnay dtolnay 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 Mar 29, 2022
@sourcefrog
Copy link
Contributor Author

Done, please take another look.

r? @dtolnay

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.

Thanks!

@dtolnay
Copy link
Member

dtolnay commented Mar 30, 2022

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Mar 30, 2022

📌 Commit cfee2ed 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 30, 2022
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 30, 2022
Rollup of 5 pull requests

Successful merges:

 - rust-lang#95294 (Document Linux kernel handoff in std::io::copy and std::fs::copy)
 - rust-lang#95443 (Clarify how `src/tools/x` searches for python)
 - rust-lang#95452 (fix since field version for termination stabilization)
 - rust-lang#95460 (Spellchecking compiler code)
 - rust-lang#95461 (Spellchecking some comments)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit e332f3b into rust-lang:master Mar 30, 2022
@rustbot rustbot added this to the 1.61.0 milestone Mar 30, 2022
@sourcefrog sourcefrog deleted the doc-copy branch March 30, 2022 14:11
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.

6 participants