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

Improve and expand documentation of pipes #134373

Merged
merged 1 commit into from
Jan 26, 2025
Merged

Conversation

joshtriplett
Copy link
Member

  • Reference UNIX, not just Linux
  • Simplify some of the language
  • Don't imply that pipes only work across multiple processes; instead,
    suggest that they're typically used across two or more separate
    processes.
  • Specify that portable applications cannot use multiple readers or
    multiple writers for messages larger than a byte, due to potential
    interleaving.

Tracking issue for anonymous pipes:
#127154

@rustbot
Copy link
Collaborator

rustbot commented Dec 16, 2024

r? @joboet

rustbot has assigned @joboet.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Dec 16, 2024
Copy link
Member

@joboet joboet left a comment

Choose a reason for hiding this comment

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

r=me with the comment nit applied

library/std/src/pipe.rs Outdated Show resolved Hide resolved
@joboet joboet 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 Jan 12, 2025
@bors
Copy link
Contributor

bors commented Jan 18, 2025

☔ The latest upstream changes (presumably #135682) made this pull request unmergeable. Please resolve the merge conflicts.

@joshtriplett
Copy link
Member Author

@bors r=joboet rollup

@bors
Copy link
Contributor

bors commented Jan 25, 2025

📌 Commit ee77d7f has been approved by joboet

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 Jan 25, 2025
@joshtriplett
Copy link
Member Author

@bors r-

@bors bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jan 25, 2025
- Simplify some of the language
- Minor grammar fixes
- Don't imply that pipes *only* work across multiple processes; instead,
  *suggest* that they're typically used across two or more separate
  processes.
- Specify that portable applications cannot use multiple readers or
  multiple writers for messages larger than a byte, due to potential
  interleaving.
- Remove no-longer-referenced footnote URLs.
@joshtriplett
Copy link
Member Author

Rewrote to apply atop current HEAD, which had changed as a result of the move from std::pipe to std::io.

@joshtriplett
Copy link
Member Author

@bors r=joboet rollup

@bors
Copy link
Contributor

bors commented Jan 25, 2025

📌 Commit 687607c has been approved by joboet

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 Jan 25, 2025
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 26, 2025
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#134300 (remove long-deprecated no-op attributes no_start and crate_id)
 - rust-lang#134373 (Improve and expand documentation of pipes)
 - rust-lang#135934 (Include missing item in the 1.81 release notes)
 - rust-lang#136005 (ports last few library files to new intrinsic style)
 - rust-lang#136016 (Improve check-cfg expected names diagnostic)
 - rust-lang#136039 (docs: fix typo in std::pin overview)
 - rust-lang#136056 (Fix typo in const stability error message)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 20d0f01 into rust-lang:master Jan 26, 2025
6 checks passed
@rustbot rustbot added this to the 1.86.0 milestone Jan 26, 2025
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jan 26, 2025
Rollup merge of rust-lang#134373 - joshtriplett:pipe-docs, r=joboet

Improve and expand documentation of pipes

- Reference UNIX, not just Linux
- Simplify some of the language
- Don't imply that pipes *only* work across multiple processes; instead,
  *suggest* that they're typically used across two or more separate
  processes.
- Specify that portable applications cannot use multiple readers or
  multiple writers for messages larger than a byte, due to potential
  interleaving.

Tracking issue for anonymous pipes:
rust-lang#127154
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. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants