summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2013-09-15 08:37:57 (GMT)
committerGeorg Brandl <georg@python.org>2013-09-15 08:37:57 (GMT)
commit5642ff9d8eefb0068eeb99c31320d3c6a319ea88 (patch)
tree7e2226735e3923ac6392230ff23f06b5b487e652 /Doc
parentc76aa4832b1b5c2898fe78a188835270bf7b70f6 (diff)
downloadcpython-5642ff9d8eefb0068eeb99c31320d3c6a319ea88.zip
cpython-5642ff9d8eefb0068eeb99c31320d3c6a319ea88.tar.gz
cpython-5642ff9d8eefb0068eeb99c31320d3c6a319ea88.tar.bz2
Fixup reST syntax errors and streamline docs of PEP 446.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/os.rst25
-rw-r--r--Doc/whatsnew/3.4.rst8
2 files changed, 16 insertions, 17 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index fc909f2..f9f9df8 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1206,41 +1206,40 @@ Querying the size of a terminal
Inheritance of File Descriptors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-A file descriptor has a inheritable flag which indicates if the file descriptor
-can be inherited or not in child processes. Since Python 3.4, file descriptors
+.. versionadded:: 3.4
+
+A file descriptor has an "inheritable" flag which indicates if the file descriptor
+can be inherited by child processes. Since Python 3.4, file descriptors
created by Python are non-inheritable by default.
On UNIX, non-inheritable file descriptors are closed in child processes at the
execution of a new program, other file descriptors are inherited.
On Windows, non-inheritable handles and file descriptors are closed in child
-processes, except standard streams (file descriptors 0, 1 and 2: stdin, stdout
-and stderr) which are always inherited. Using :func:`os.spawn*` functions,
+processes, except for standard streams (file descriptors 0, 1 and 2: stdin, stdout
+and stderr), which are always inherited. Using :func:`os.spawn*` functions,
all inheritable handles and all inheritable file descriptors are inherited.
Using the :mod:`subprocess` module, all file descriptors except standard
-streams are closed, inheritable handles are only inherited if the *close_fds*
-parameter is ``False``.
-
-.. versionadded:: 3.4
+streams are closed, and inheritable handles are only inherited if the
+*close_fds* parameter is ``False``.
.. function:: get_inheritable(fd)
- Get the `inheritable flag <fd_inheritance>`_ of the specified file
- descriptor. Return a :class:`bool`.
+ Get the "inheritable" flag of the specified file descriptor (a boolean).
.. function:: set_inheritable(fd, inheritable)
- Set the `inheritable flag <fd_inheritance>`_ of the specified file descriptor.
+ Set the "inheritable" flag of the specified file descriptor.
.. function:: get_handle_inheritable(handle)
- Get the `inheritable flag <fd_inheritance>`_ of the specified handle. Return a :class:`bool`.
+ Get the "inheritable" flag of the specified handle (a boolean).
Availability: Windows.
.. function:: set_handle_inheritable(handle, inheritable)
- Set the `inheritable flag <fd_inheritance>`_ of the specified handle.
+ Set the "inheritable" flag of the specified handle.
Availability: Windows.
diff --git a/Doc/whatsnew/3.4.rst b/Doc/whatsnew/3.4.rst
index c183ef8..0749f03 100644
--- a/Doc/whatsnew/3.4.rst
+++ b/Doc/whatsnew/3.4.rst
@@ -126,8 +126,8 @@ Please read on for a comprehensive list of user-facing changes.
PEP 446: Make newly created file descriptors non-inheritable
============================================================
-The :pep:`446` makes newly created file descriptors `non-inheritable
-<fd_inheritance>`_. New functions and methods:
+The :pep:`446` makes newly created file descriptors :ref:`non-inheritable
+<fd_inheritance>`. New functions and methods:
* :func:`os.get_inheritable`, :func:`os.set_inheritable`
* :func:`os.get_handle_inheritable`, :func:`os.set_handle_inheritable`
@@ -318,8 +318,8 @@ try/except statement by code that only cares whether or not an error occurred.
socket
------
-Socket objects have new methods to get or set their `inheritable flag
-<fd_inheritance>`_:
+Socket objects have new methods to get or set their :ref:`inheritable flag
+<fd_inheritance>`:
* :meth:`socket.socket.get_inheritable`, :meth:`socket.socket.set_inheritable`