Changeset 391 for python/trunk/Doc/library/fcntl.rst

Timestamp:

Mar 19, 2014, 11:31:01 PM (11 years ago)

Author:

dmik

Message:

python: Merge vendor 2.7.6 to trunk.

Location:

python/trunk

Files:

• . (modified) (1 prop)
• Doc/library/fcntl.rst (modified) (8 diffs)

python/trunk/Doc/library/fcntl.rst

@@ -1 @@
-
-:mod:`fcntl` --- The :func:`fcntl` and :func:`ioctl` system calls
-=================================================================
+:mod:`fcntl` --- The ``fcntl`` and ``ioctl`` system calls
+=========================================================
 
 .. module:: fcntl
@@ -10 +9 @@
 
 .. index::
-   pair: UNIX@Unix; file control
-   pair: UNIX@Unix; I/O control
+   pair: UNIX; file control
+   pair: UNIX; I/O control
 
 This module performs file control and I/O control on file descriptors. It is an
-interface to the :cfunc:`fcntl` and :cfunc:`ioctl` Unix routines.
+interface to the :c:func:`fcntl` and :c:func:`ioctl` Unix routines.
 
 All functions in this module take a file descriptor *fd* as their first
 argument.  This can be an integer file descriptor, such as returned by
 ``sys.stdin.fileno()``, or a file object, such as ``sys.stdin`` itself, which
-provides a :meth:`fileno` which returns a genuine file descriptor.
+provides a :meth:`~io.IOBase.fileno` which returns a genuine file descriptor.
 
 The module defines the following functions:
@@ -27 +26 @@
 
    Perform the requested operation on file descriptor *fd* (file objects providing
-   a :meth:`fileno` method are accepted as well). The operation is defined by *op*
+   a :meth:`~io.IOBase.fileno` method are accepted as well). The operation is
+   defined by *op*
    and is operating system dependent.  These codes are also found in the
    :mod:`fcntl` module. The argument *arg* is optional, and defaults to the integer
    value ``0``.  When present, it can either be an integer value, or a string.
    With the argument missing or an integer value, the return value of this function
-   is the integer return value of the C :cfunc:`fcntl` call.  When the argument is
+   is the integer return value of the C :c:func:`fcntl` call.  When the argument is
    a string it represents a binary structure, e.g. created by :func:`struct.pack`.
    The binary data is copied to a buffer whose address is passed to the C
-   :cfunc:`fcntl` call.  The return value after a successful call is the contents
+   :c:func:`fcntl` call.  The return value after a successful call is the contents
    of the buffer, converted to a string object.  The length of the returned string
    will be the same as the length of the *arg* argument.  This is limited to 1024
@@ -42 +42 @@
    violation or a more subtle data corruption.
 
-   If the :cfunc:`fcntl` fails, an :exc:`IOError` is raised.
+   If the :c:func:`fcntl` fails, an :exc:`IOError` is raised.
 
 
 .. function:: ioctl(fd, op[, arg[, mutate_flag]])
 
-   This function is identical to the :func:`fcntl` function, except that the
+   This function is identical to the :func:`~fcntl.fcntl` function, except that the
    operations are typically defined in the library module :mod:`termios` and the
    argument handling is even more complicated.
@@ -57 +57 @@
    a plain Python string) or an object supporting the read-write buffer interface.
 
-   In all but the last case, behaviour is as for the :func:`fcntl` function.
+   In all but the last case, behaviour is as for the :func:`~fcntl.fcntl`
+   function.
 
    If a mutable buffer is passed, then the behaviour is determined by the value of
@@ -96 +97 @@
 
    Perform the lock operation *op* on file descriptor *fd* (file objects providing
-   a :meth:`fileno` method are accepted as well). See the Unix manual
+   a :meth:`~io.IOBase.fileno` method are accepted as well). See the Unix manual
    :manpage:`flock(2)` for details.  (On some systems, this function is emulated
-   using :cfunc:`fcntl`.)
+   using :c:func:`fcntl`.)
 
 
 .. function:: lockf(fd, operation, [length, [start, [whence]]])
 
-   This is essentially a wrapper around the :func:`fcntl` locking calls.  *fd* is
-   the file descriptor of the file to lock or unlock, and *operation* is one of the
-   following values:
+   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 *operation*
+   is one of the following values:
 
    * :const:`LOCK_UN` -- unlock
@@ -120 +121 @@
    file opened for writing.
 
-   *length* is the number of bytes to lock, *start* is the byte offset at which the
-   lock starts, relative to *whence*, and *whence* is as with :func:`fileobj.seek`,
-   specifically:
+   *length* is the number of bytes to lock, *start* is the byte offset at
+   which the lock starts, relative to *whence*, and *whence* is as with
+   :func:`io.IOBase.seek`, specifically:
 
-   * :const:`0` -- relative to the start of the file (:const:`SEEK_SET`)
-   * :const:`1` -- relative to the current buffer position (:const:`SEEK_CUR`)
-   * :const:`2` -- relative to the end of the file (:const:`SEEK_END`)
+   * :const:`0` -- relative to the start of the file (:data:`os.SEEK_SET`)
+   * :const:`1` -- relative to the current buffer position (:data:`os.SEEK_CUR`)
+   * :const:`2` -- relative to the end of the file (:data:`os.SEEK_END`)
 
    The default for *start* is 0, which means to start at the beginning of the file.
@@ -151 +152 @@
 
    Module :mod:`os`
-      If the locking flags :const:`O_SHLOCK` and :const:`O_EXLOCK` are 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.
+      If the locking flags :data:`~os.O_SHLOCK` and :data:`~os.O_EXLOCK` are
+      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.