summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-12-28 11:49:41 (GMT)
committerGeorg Brandl <georg@python.org>2010-12-28 11:49:41 (GMT)
commite9e8c9bda486c2694e9dfa462c0d43a3476e5d7c (patch)
tree395fb0ce8b4eb8438bd7d0b455755bda1eb74752 /Doc
parent9d9848e7763d5e5d6e6a3a6610928f4aeec95c41 (diff)
downloadcpython-e9e8c9bda486c2694e9dfa462c0d43a3476e5d7c.zip
cpython-e9e8c9bda486c2694e9dfa462c0d43a3476e5d7c.tar.gz
cpython-e9e8c9bda486c2694e9dfa462c0d43a3476e5d7c.tar.bz2
#10739: document that on Windows, socket.makefile() does not make a file that has a true file descriptor usable where such a thing is expected.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/ACKS.txt1
-rw-r--r--Doc/library/socket.rst22
2 files changed, 15 insertions, 8 deletions
diff --git a/Doc/ACKS.txt b/Doc/ACKS.txt
index 2dd3b55..ae34348 100644
--- a/Doc/ACKS.txt
+++ b/Doc/ACKS.txt
@@ -111,6 +111,7 @@ docs@python.org), and we'll be glad to correct the problem.
* Andrew M. Kuchling
* Dave Kuhlman
* Erno Kuusela
+ * Ross Lagerwall
* Thomas Lamb
* Detlef Lannert
* Piers Lauder
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index b90c0d8..0a0f764 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -634,18 +634,24 @@ correspond to Unix system calls applicable to sockets.
is system-dependent (usually 5).
-.. method:: socket.makefile(mode='r', buffering=None, *, encoding=None, errors=None, newline=None)
+.. method:: socket.makefile(mode='r', buffering=None, *, encoding=None, \
+ errors=None, newline=None)
.. index:: single: I/O control; buffering
- Return a :term:`file object` associated with the socket. The exact
- returned type depends on the arguments given to :meth:`makefile`. These
- arguments are interpreted the same way as by the built-in :func:`open`
- function.
+ Return a :term:`file object` associated with the socket. The exact returned
+ type depends on the arguments given to :meth:`makefile`. These arguments are
+ interpreted the same way as by the built-in :func:`open` function.
- Closing the file object won't close the socket unless there are no
- remaining references to the socket. The socket must be in blocking mode
- (it can not have a timeout).
+ Closing the file object won't close the socket unless there are no remaining
+ references to the socket. The socket must be in blocking mode (it can not
+ have a timeout).
+
+ .. note::
+
+ On Windows, the file-like object created by :meth:`makefile` cannot be
+ used where a file object with a file descriptor is expected, such as the
+ stream arguments of :meth:`subprocess.Popen`.
.. method:: socket.recv(bufsize[, flags])