From: Guido van Rossum <guido@python.org>
Date: Fri, 11 Oct 1996 17:43:34 +0000 (+0000)
Subject: Added embryonic description of fcntl.lockf().  Added pointer to that
X-Git-Tag: v1.4~99
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9b0581192d6f3f959e724b9db9f7726d3861e180;p=python

Added embryonic description of fcntl.lockf().  Added pointer to that
in posixfile (which is obsolescent).
---

diff --git a/Doc/lib/libfcntl.tex b/Doc/lib/libfcntl.tex
index 1aba52095e..3a51ce1c6e 100644
--- a/Doc/lib/libfcntl.tex
+++ b/Doc/lib/libfcntl.tex
@@ -42,6 +42,11 @@ See the Unix manual for details.  (On some systems, this function is
 emulated using \code{fcntl}.)
 \end{funcdesc}
 
+\begin{funcdesc}{lockf}{fd\, code\, \optional{len\, \optional{start\, \optional{whence}}}}
+This is a wrapper around the \code{F_SETLK} and \code{F_SETLKW}
+\code{fcntl()} calls.  See the Unix manual for details.
+\end{funcdesc}
+
 If the library modules \code{FCNTL} or \code{IOCTL} are missing, you
 can find the opcodes in the C include files \code{sys/fcntl} and
 \code{sys/ioctl}. You can create the modules yourself with the h2py
diff --git a/Doc/lib/libposixfile.tex b/Doc/lib/libposixfile.tex
index 6679f12280..5c853e778c 100644
--- a/Doc/lib/libposixfile.tex
+++ b/Doc/lib/libposixfile.tex
@@ -3,6 +3,10 @@
 \bimodindex{posixfile}
 \indexii{posix}{file object}
 
+\emph{Note:} This module will become obsolete in a future release.
+The locking operation that it provides is done better and more
+portably by the \code{fcntl.lockf()} call.
+
 This module implements some additional functionality over the built-in
 file objects.  In particular, it implements file locking, control over
 the file flags, and an easy interface to duplicate the file object.
diff --git a/Doc/libfcntl.tex b/Doc/libfcntl.tex
index 1aba52095e..3a51ce1c6e 100644
--- a/Doc/libfcntl.tex
+++ b/Doc/libfcntl.tex
@@ -42,6 +42,11 @@ See the Unix manual for details.  (On some systems, this function is
 emulated using \code{fcntl}.)
 \end{funcdesc}
 
+\begin{funcdesc}{lockf}{fd\, code\, \optional{len\, \optional{start\, \optional{whence}}}}
+This is a wrapper around the \code{F_SETLK} and \code{F_SETLKW}
+\code{fcntl()} calls.  See the Unix manual for details.
+\end{funcdesc}
+
 If the library modules \code{FCNTL} or \code{IOCTL} are missing, you
 can find the opcodes in the C include files \code{sys/fcntl} and
 \code{sys/ioctl}. You can create the modules yourself with the h2py
diff --git a/Doc/libposixfile.tex b/Doc/libposixfile.tex
index 6679f12280..5c853e778c 100644
--- a/Doc/libposixfile.tex
+++ b/Doc/libposixfile.tex
@@ -3,6 +3,10 @@
 \bimodindex{posixfile}
 \indexii{posix}{file object}
 
+\emph{Note:} This module will become obsolete in a future release.
+The locking operation that it provides is done better and more
+portably by the \code{fcntl.lockf()} call.
+
 This module implements some additional functionality over the built-in
 file objects.  In particular, it implements file locking, control over
 the file flags, and an easy interface to duplicate the file object.