Add documentation for anonymous pipe module #133986

olishmollie · 2024-12-06T23:30:47Z

Tracking issue: #127154

@NobodyXu I've been using this feature lately and thought I might contribute with some documentation. I borrowed liberally from os_pipe so thanks to @oconnor663.

rustbot · 2024-12-06T23:30:54Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @NobodyXu (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

NobodyXu

Thank you so much!

I just have 3 suggestions:

library/std/src/pipe.rs

olishmollie · 2024-12-07T17:42:54Z

@rustbot review

NobodyXu

Thanks, just one final comment:

library/std/src/pipe.rs

NobodyXu

Thank you!

It LGTM, but unfortunately I don't have power to merge, you'd need to r? to assign another rust member to merge it.

Sorry I should say this earlier

jieyouxu · 2024-12-09T07:13:37Z

r? libs

library/std/src/pipe.rs

tgross35 · 2024-12-13T06:57:10Z

Thanks, these docs are a great update!

Could you add some comments to the examples explaining what is going on? E.g. // Create a pipe that sends back whatever it receives, // Spawn a process that will write to the pipe etc.

Also do these need to be no_run? I think they should work find on #[cfg(unix)] (maybe change bash to sh).

r? tgross35

olishmollie · 2024-12-14T07:58:44Z

Could you add some comments to the examples explaining what is going on? E.g. // Create a pipe that sends back whatever it receives, // Spawn a process that will write to the pipe etc.

Done.

Also do these need to be no_run? I think they should work find on #[cfg(unix)] (maybe change bash to sh).

I think it's better to leave them no_run rather than chance breaking someone's build. For example, posix shell doesn't support read -n.

tgross35

I think it's better to leave them no_run rather than chance breaking someone's build. For example, posix shell doesn't support read -n.

That one in particular should stay no_run anyway since it writes to the file system. The others would be okay but no harm in skipping them.

Can you just confirm that these tests do pass on your system or on the playground?

olishmollie · 2024-12-14T21:43:26Z

Can you just confirm that these tests do pass on your system or on the playground?

I tested the examples without no_run when I wrote them (just confirmed again to be sure), and can confirm they all run in the playground.

tgross35 · 2024-12-14T21:45:26Z

Great, thanks!

@bors r+ rollup

bors · 2024-12-14T21:45:29Z

📌 Commit fb6a19b has been approved by tgross35

It is now in the queue for this repository.

olishmollie · 2024-12-14T21:46:35Z

Sorry @tgross35, I only realized you had approved the changes after I requested another review. Not sure what happens now, but thanks for looking it over and for the great suggestions.

tgross35 · 2024-12-14T21:50:36Z

GH reviews are just a nice API but don't really matter (I only re-approved to dismiss the review request :) ), Bors handles merging. My r+ comment added it to the queue (see the queue comment above), this will eventually get picked up with a couple other changes (a "rollup"), run against the full test suite, and merged. Usually it takes a few hours to a day, no action needed from you though.

…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#132939 (Suggest using deref in patterns) - rust-lang#133293 (Updates Solaris target information, adds Solaris maintainer) - rust-lang#133392 (Fix ICE when multiple supertrait substitutions need assoc but only one is provided) - rust-lang#133986 (Add documentation for anonymous pipe module) - rust-lang#134022 (Doc: Extend for tuples to be stabilized in 1.85.0) - rust-lang#134259 (Clean up `infer_return_ty_for_fn_sig`) - rust-lang#134264 (Arbitrary self types v2: Weak & NonNull diagnostics) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#133986 - olishmollie:tracking-issue-127154-documentation, r=tgross35 Add documentation for anonymous pipe module Tracking issue: rust-lang#127154 `@NobodyXu` I've been using this feature lately and thought I might contribute with some documentation. I borrowed liberally from [os_pipe](https://docs.rs/os_pipe/latest/os_pipe/) so thanks to `@oconnor663.`

This comment was marked as resolved.

Sign in to view

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 6, 2024

This comment was marked as resolved.

Sign in to view

NobodyXu suggested changes Dec 7, 2024

View reviewed changes

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

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

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

olishmollie force-pushed the tracking-issue-127154-documentation branch from f850623 to 39212d8 Compare December 7, 2024 16:43

NobodyXu suggested changes Dec 7, 2024

View reviewed changes

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

olishmollie force-pushed the tracking-issue-127154-documentation branch from 39212d8 to 6ef2822 Compare December 8, 2024 20:17

NobodyXu approved these changes Dec 9, 2024

View reviewed changes

This comment was marked as resolved.

Sign in to view

rustbot assigned Noratrieb Dec 9, 2024

jieyouxu added the F-anonymous_pipe `#![feature(anonymous_pipe)]` label Dec 9, 2024

tgross35 reviewed Dec 13, 2024

View reviewed changes

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

tgross35 reviewed Dec 13, 2024

View reviewed changes

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

tgross35 reviewed Dec 13, 2024

View reviewed changes

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

tgross35 reviewed Dec 13, 2024

View reviewed changes

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

rustbot assigned tgross35 and unassigned Noratrieb Dec 13, 2024

olishmollie force-pushed the tracking-issue-127154-documentation branch from 6ef2822 to 83110fa Compare December 14, 2024 07:58

Add documentation for anonymous pipe module

fb6a19b

olishmollie force-pushed the tracking-issue-127154-documentation branch from 83110fa to fb6a19b Compare December 14, 2024 08:10

olishmollie requested a review from tgross35 December 14, 2024 20:01

tgross35 approved these changes Dec 14, 2024

View reviewed changes

tgross35 added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Dec 14, 2024

olishmollie requested a review from tgross35 December 14, 2024 21:44

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 Dec 14, 2024

tgross35 approved these changes Dec 14, 2024

View reviewed changes

matthiaskrgr mentioned this pull request Dec 14, 2024

Rollup of 7 pull requests #134318

Merged

bors merged commit 08b9aa0 into rust-lang:master Dec 15, 2024
6 checks passed

rustbot added this to the 1.85.0 milestone Dec 15, 2024

NobodyXu mentioned this pull request Dec 15, 2024

Tracking Issue for anonymous pipe API #127154

Open

4 tasks

olishmollie deleted the tracking-issue-127154-documentation branch December 15, 2024 06:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for anonymous pipe module #133986

Add documentation for anonymous pipe module #133986

olishmollie commented Dec 6, 2024 •

edited by jieyouxu

Loading

This comment was marked as resolved.

rustbot commented Dec 6, 2024

This comment was marked as resolved.

This comment was marked as resolved.

NobodyXu left a comment •

edited

Loading

olishmollie commented Dec 7, 2024

NobodyXu left a comment

NobodyXu left a comment

This comment was marked as resolved.

This comment was marked as resolved.

jieyouxu commented Dec 9, 2024

tgross35 commented Dec 13, 2024

olishmollie commented Dec 14, 2024 •

edited

Loading

tgross35 left a comment

olishmollie commented Dec 14, 2024

tgross35 commented Dec 14, 2024

bors commented Dec 14, 2024

olishmollie commented Dec 14, 2024

tgross35 commented Dec 14, 2024

Add documentation for anonymous pipe module #133986

Add documentation for anonymous pipe module #133986

Conversation

olishmollie commented Dec 6, 2024 • edited by jieyouxu Loading

This comment was marked as resolved.

rustbot commented Dec 6, 2024

This comment was marked as resolved.

This comment was marked as resolved.

NobodyXu left a comment • edited Loading

Choose a reason for hiding this comment

olishmollie commented Dec 7, 2024

NobodyXu left a comment

Choose a reason for hiding this comment

NobodyXu left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

jieyouxu commented Dec 9, 2024

tgross35 commented Dec 13, 2024

olishmollie commented Dec 14, 2024 • edited Loading

tgross35 left a comment

Choose a reason for hiding this comment

olishmollie commented Dec 14, 2024

tgross35 commented Dec 14, 2024

bors commented Dec 14, 2024

olishmollie commented Dec 14, 2024

tgross35 commented Dec 14, 2024

olishmollie commented Dec 6, 2024 •

edited by jieyouxu

Loading

NobodyXu left a comment •

edited

Loading

olishmollie commented Dec 14, 2024 •

edited

Loading