about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorAndreas Tolfsen <ato@sny.no>2018-03-28 18:54:34 +0100
committerAndreas Tolfsen <ato@sny.no>2018-03-28 18:54:34 +0100
commit7eb9a091f3ab8e77978ad5c8369f2fb4bedc2610 (patch)
tree59d8f1ce83b03ca9cfe39f369b188c696437c84d /src/libstd
parentd87c19db6df9189a2beb43e7998d0cc5548878b3 (diff)
downloadrust-7eb9a091f3ab8e77978ad5c8369f2fb4bedc2610.tar.gz
rust-7eb9a091f3ab8e77978ad5c8369f2fb4bedc2610.zip
std: Child::kill() returns error if process has already exited
This patch makes it clear in std::process::Child::kill()'s API
documentation that an error is returned if the child process has
already cleanly exited.  This is implied by the example, but not
called out explicitly.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/process.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/libstd/process.rs b/src/libstd/process.rs
index 92e9f48f7eb..b3cb8d745b4 100644
--- a/src/libstd/process.rs
+++ b/src/libstd/process.rs
@@ -1121,8 +1121,9 @@ impl ExitCode {
 }
 
 impl Child {
-    /// Forces the child to exit. This is equivalent to sending a
-    /// SIGKILL on unix platforms.
+    /// Forces the child process to exit.  If the child has already exited, an error is returned.
+    ///
+    /// This is equivalent to sending a SIGKILL on Unix platforms.
     ///
     /// # Examples
     ///