about summary refs log tree commit diff
diff options
context:
space:
mode:
authorPirh <pirh.badger@gmail.com>2017-10-09 19:20:07 +0100
committerPirh <pirh.badger@gmail.com>2017-10-09 19:20:07 +0100
commit6f653bb1b15b327c1adb5018e2957631cd708d5d (patch)
treea2d0df56f61c10dd7f65e4c27a7747b7a617fcd4
parent3ed8b698421291f5057059da885cd670d76a47e9 (diff)
downloadrust-6f653bb1b15b327c1adb5018e2957631cd708d5d.tar.gz
rust-6f653bb1b15b327c1adb5018e2957631cd708d5d.zip
Document defaults for stdin, stdout, and stderr methods of Command
-rw-r--r--src/libstd/process.rs27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/libstd/process.rs b/src/libstd/process.rs
index dbb58991215..1352c640fdd 100644
--- a/src/libstd/process.rs
+++ b/src/libstd/process.rs
@@ -552,6 +552,15 @@ 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`.
+    ///
+    /// On Windows, if the `#![windows_subsystem = "windows"]` attribute is
+    /// set, no stdin is connected unless explicitly assigned.
+    ///
+    /// [`inherit`]: struct.Stdio.html#method.inherit
+    /// [`piped`]: struct.Stdio.html#method.piped
+    ///
     /// # Examples
     ///
     /// Basic usage:
@@ -572,6 +581,15 @@ 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`.
+    ///
+    /// On Windows, if the `#![windows_subsystem = "windows"]` attribute is
+    /// set, no stdout is connected unless explicitly assigned.
+    ///
+    /// [`inherit`]: struct.Stdio.html#method.inherit
+    /// [`piped`]: struct.Stdio.html#method.piped
+    ///
     /// # Examples
     ///
     /// Basic usage:
@@ -592,6 +610,15 @@ 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`.
+    ///
+    /// On Windows, if the `#![windows_subsystem = "windows"]` attribute is
+    /// set, no stderr is connected unless explicitly assigned.
+    ///
+    /// [`inherit`]: struct.Stdio.html#method.inherit
+    /// [`piped`]: struct.Stdio.html#method.piped
+    ///
     /// # Examples
     ///
     /// Basic usage: