[Python-checkins] bpo-26836: Document os.memfd_create() name parameter (GH-13838)

Miss Islington (bot) webhook-mailer at python.org
Wed Jun 5 06:24:56 EDT 2019

commit: ccf0efbb21f6bbf6efd5f8cb560fed11079ce1a2
branch: master
author: Victor Stinner <vstinner at redhat.com>
committer: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
date: 2019-06-05T03:24:52-07:00

bpo-26836: Document os.memfd_create() name parameter (GH-13838)


M Doc/library/os.rst

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 107764ba4d53..f0df35e9ddd5 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -3011,6 +3011,13 @@ features:
    (or a bitwise ORed combination of them).  By default, the new file
    descriptor is :ref:`non-inheritable <fd_inheritance>`.
+   The name supplied in *name* is used as a filename and will be displayed as
+   the target of the corresponding symbolic link in the directory
+   ``/proc/self/fd/``. The displayed name is always prefixed with ``memfd:``
+   and serves only for debugging purposes. Names do not affect the behavior of
+   the file descriptor, and as such multiple files can have the same name
+   without any side effects.
    .. availability:: Linux 3.17 or newer with glibc 2.27 or newer.
    .. versionadded:: 3.8

More information about the Python-checkins mailing list