From: Berker Peksag <berker.peksag@gmail.com>
Date: Mon, 26 Sep 2016 20:22:22 +0000 (+0300)
Subject: Issue #10673: Document that Process.exitcode can be used to determine timeout
X-Git-Tag: v3.6.0b2~114^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a24d2d82746fcdeddd635394b22e5ab480cbad4d;p=thirdparty%2FPython%2Fcpython.git

Issue #10673: Document that Process.exitcode can be used to determine timeout

Patch by Tom Clark.
---

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index d20098ffa7c2..a5912f77a864 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -496,6 +496,9 @@ The :mod:`multiprocessing` package mostly replicates the API of the
       If the optional argument *timeout* is ``None`` (the default), the method
       blocks until the process whose :meth:`join` method is called terminates.
       If *timeout* is a positive number, it blocks at most *timeout* seconds.
+      Note that the method returns ``None`` if its process terminates or if the
+      method times out.  Check the process's :attr:`exitcode` to determine if
+      it terminated.
 
       A process can be joined many times.