From: Ben Darnell <ben@bendarnell.com>
Date: Sun, 22 May 2016 01:32:13 +0000 (-0400)
Subject: Document Subprocess as posix-only
X-Git-Tag: v4.4.0b1~18^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1722%2Fhead;p=thirdparty%2Ftornado.git

Document Subprocess as posix-only

Fixes #1585
---

diff --git a/tornado/process.py b/tornado/process.py
index 64e77c72d..a3545b0f9 100644
--- a/tornado/process.py
+++ b/tornado/process.py
@@ -201,8 +201,14 @@ class Subprocess(object):
       attribute of the resulting Subprocess a `.PipeIOStream`.
     * A new keyword argument ``io_loop`` may be used to pass in an IOLoop.
 
+    The ``Subprocess.STREAM`` option and the ``set_exit_callback`` and
+    ``wait_for_exit`` methods do not work on Windows. There is
+    therefore no reason to use this class instead of
+    ``subprocess.Popen`` on that platform.
+
     .. versionchanged:: 4.1
        The ``io_loop`` argument is deprecated.
+
     """
     STREAM = object()