summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-06-05 11:16:00 (GMT)
committerVictor Stinner <vstinner@redhat.com>2019-06-05 11:16:00 (GMT)
commitb496c2672131ea51a55b5a414aeda271562f18d3 (patch)
tree16c95664fb6320901888f3a2952e15042053cbbc
parent87a865ec15fa899a1f12be81f41a4c5e649a2833 (diff)
downloadcpython-b496c2672131ea51a55b5a414aeda271562f18d3.zip
cpython-b496c2672131ea51a55b5a414aeda271562f18d3.tar.gz
cpython-b496c2672131ea51a55b5a414aeda271562f18d3.tar.bz2
bpo-26836: Document os.memfd_create() name parameter (GH-13838) (GH-13839)
https://bugs.python.org/issue26836 (cherry picked from commit ccf0efbb21f6bbf6efd5f8cb560fed11079ce1a2) Co-authored-by: Victor Stinner <vstinner@redhat.com>
-rw-r--r--Doc/library/os.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 107764b..f0df35e9 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