From 5642ff9d8eefb0068eeb99c31320d3c6a319ea88 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 15 Sep 2013 10:37:57 +0200 Subject: [PATCH] Fixup reST syntax errors and streamline docs of PEP 446. --- Doc/library/os.rst | 25 ++++++++++++------------- Doc/whatsnew/3.4.rst | 8 ++++---- 2 files changed, 16 insertions(+), 17 deletions(-) diff --git a/Doc/library/os.rst b/Doc/library/os.rst index fc909f2055..f9f9df867f 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 `_ 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 `_ of the specified file descriptor. + Set the "inheritable" flag of the specified file descriptor. .. function:: get_handle_inheritable(handle) - Get the `inheritable flag `_ 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 `_ 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 c183ef8c82..0749f032f7 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 -`_. New functions and methods: +The :pep:`446` makes newly created file descriptors :ref:`non-inheritable +`. 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 -`_: +Socket objects have new methods to get or set their :ref:`inheritable flag +`: * :meth:`socket.socket.get_inheritable`, :meth:`socket.socket.set_inheritable` -- 2.40.0