Skip to content

Commit df5237a

Browse files
committed
Clarify doc comment for CommentExt::inherit_oci_pipes()
1 parent 445555d commit df5237a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/pipe.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ const SYNC_PIPE_FD: RawFd = 4;
1919
/// An extension trait for `tokio::process::Command`.
2020
pub trait CommandExt {
2121
/// Configures the child process to accept `_OCI_STARTPIPE` and `_OCI_SYNCPIPE`.
22+
///
23+
/// This will assign the given start and sync pipes to file descriptors 3 and 4, respectively.
24+
/// This is because file descriptors 0, 1, and 2 are already used by `stdin`, `stdout`, and
25+
/// `stderr`.
2226
fn inherit_oci_pipes(&mut self, start: &StartPipe, sync: &SyncPipe) -> &mut Self;
2327
}
2428

0 commit comments

Comments
 (0)