about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorkennytm <kennytm@gmail.com>2017-10-17 22:20:57 +0800
committerGitHub <noreply@github.com>2017-10-17 22:20:57 +0800
commit18f289559e6801fc5feb74b1ff602588f33958ed (patch)
tree1405e823b811e4c49ad514e7d4375cc6fbbc635b /src/libstd
parent40d61f5982876ed17844742b0db56d3507d9e245 (diff)
parent210c91100fe76926647eb5d71a77dc3b527ef038 (diff)
downloadrust-18f289559e6801fc5feb74b1ff602588f33958ed.tar.gz
rust-18f289559e6801fc5feb74b1ff602588f33958ed.zip
Rollup merge of #45151 - Pirh:stdio_default_docs, r=frewsxcv
Document defaults for stdin, stdout, and stderr methods of Command

For #29370
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/process.rs18
1 files changed, 18 insertions, 0 deletions
diff --git a/src/libstd/process.rs b/src/libstd/process.rs
index f448cffd372..533f6590f83 100644
--- a/src/libstd/process.rs
+++ b/src/libstd/process.rs
@@ -552,6 +552,12 @@ impl Command {
 
     /// Configuration for the child process's standard input (stdin) handle.
     ///
+    /// Defaults to [`inherit`] when used with `spawn` or `status`, and
+    /// defaults to [`piped`] when used with `output`.
+    ///
+    /// [`inherit`]: struct.Stdio.html#method.inherit
+    /// [`piped`]: struct.Stdio.html#method.piped
+    ///
     /// # Examples
     ///
     /// Basic usage:
@@ -572,6 +578,12 @@ impl Command {
 
     /// Configuration for the child process's standard output (stdout) handle.
     ///
+    /// Defaults to [`inherit`] when used with `spawn` or `status`, and
+    /// defaults to [`piped`] when used with `output`.
+    ///
+    /// [`inherit`]: struct.Stdio.html#method.inherit
+    /// [`piped`]: struct.Stdio.html#method.piped
+    ///
     /// # Examples
     ///
     /// Basic usage:
@@ -592,6 +604,12 @@ impl Command {
 
     /// Configuration for the child process's standard error (stderr) handle.
     ///
+    /// Defaults to [`inherit`] when used with `spawn` or `status`, and
+    /// defaults to [`piped`] when used with `output`.
+    ///
+    /// [`inherit`]: struct.Stdio.html#method.inherit
+    /// [`piped`]: struct.Stdio.html#method.piped
+    ///
     /// # Examples
     ///
     /// Basic usage: