[Python-checkins] Doc: fcntl.lockf() is more powerful than written (GH-6750)
Miss Islington (bot)
webhook-mailer at python.org
Fri Sep 13 13:39:45 EDT 2019
https://github.com/python/cpython/commit/10873831ed95386d4834dcfb49f1c3d02f741eed
commit: 10873831ed95386d4834dcfb49f1c3d02f741eed
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-09-13T10:39:42-07:00
summary:
Doc: fcntl.lockf() is more powerful than written (GH-6750)
(cherry picked from commit 77cd0ceab2f6c1696fb1d31115c2f880b2e21934)
Co-authored-by: Eric O. LEBIGOT (EOL) <lebigot at users.noreply.github.com>
files:
M Doc/library/fcntl.rst
diff --git a/Doc/library/fcntl.rst b/Doc/library/fcntl.rst
index 2db9674952d7..a7390150f791 100644
--- a/Doc/library/fcntl.rst
+++ b/Doc/library/fcntl.rst
@@ -120,7 +120,8 @@ The module defines the following functions:
.. function:: lockf(fd, cmd, len=0, start=0, whence=0)
This is essentially a wrapper around the :func:`~fcntl.fcntl` locking calls.
- *fd* is the file descriptor of the file to lock or unlock, and *cmd*
+ *fd* is the file descriptor (file objects providing a :meth:`~io.IOBase.fileno`
+ method are accepted as well) of the file to lock or unlock, and *cmd*
is one of the following values:
* :const:`LOCK_UN` -- unlock
@@ -171,4 +172,3 @@ using the :func:`flock` call may be better.
present in the :mod:`os` module (on BSD only), the :func:`os.open`
function provides an alternative to the :func:`lockf` and :func:`flock`
functions.
-
More information about the Python-checkins
mailing list