summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-05-22 09:43:17 (GMT)
committerGeorg Brandl <georg@python.org>2009-05-22 09:43:17 (GMT)
commit012408c2b9b4d22a16d532f95018dbb78eba233c (patch)
tree967968b49ce352bba27191f948ae51af9d4b402d
parentaafd6b850e8feb57c51518d447120443e8e6e84f (diff)
downloadcpython-012408c2b9b4d22a16d532f95018dbb78eba233c.zip
cpython-012408c2b9b4d22a16d532f95018dbb78eba233c.tar.gz
cpython-012408c2b9b4d22a16d532f95018dbb78eba233c.tar.bz2
Fix references to file-related functions and methods (os.* vs file.*).
-rw-r--r--Doc/library/os.rst30
1 files changed, 15 insertions, 15 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 1109a1d..b679275 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -354,7 +354,7 @@ These functions create new file objects. (See also :func:`open`.)
is ``'r'`` (default) or ``'w'``. The *bufsize* argument has the same meaning as
the corresponding argument to the built-in :func:`open` function. The exit
status of the command (encoded in the format specified for :func:`wait`) is
- available as the return value of the :meth:`close` method of the file object,
+ available as the return value of the :meth:`~file.close` method of the file object,
except that when the exit status is zero (termination without errors), ``None``
is returned. Availability: Unix, Windows.
@@ -475,9 +475,9 @@ by file descriptors.
.. note::
This function is intended for low-level I/O and must be applied to a file
- descriptor as returned by :func:`open` or :func:`pipe`. To close a "file
+ descriptor as returned by :func:`os.open` or :func:`pipe`. To close a "file
object" returned by the built-in function :func:`open` or by :func:`popen` or
- :func:`fdopen`, use its :meth:`close` method.
+ :func:`fdopen`, use its :meth:`~file.close` method.
.. function:: closerange(fd_low, fd_high)
@@ -604,8 +604,8 @@ by file descriptors.
.. note::
This function is intended for low-level I/O. For normal usage, use the built-in
- function :func:`open`, which returns a "file object" with :meth:`read` and
- :meth:`write` methods (and many more). To wrap a file descriptor in a "file
+ function :func:`open`, which returns a "file object" with :meth:`~file.read` and
+ :meth:`~file.write` methods (and many more). To wrap a file descriptor in a "file
object", use :func:`fdopen`.
@@ -634,22 +634,22 @@ by file descriptors.
.. note::
This function is intended for low-level I/O and must be applied to a file
- descriptor as returned by :func:`open` or :func:`pipe`. To read a "file object"
+ descriptor as returned by :func:`os.open` or :func:`pipe`. To read a "file object"
returned by the built-in function :func:`open` or by :func:`popen` or
- :func:`fdopen`, or :data:`sys.stdin`, use its :meth:`read` or :meth:`readline`
- methods.
+ :func:`fdopen`, or :data:`sys.stdin`, use its :meth:`~file.read` or
+ :meth:`~file.readline` methods.
.. function:: tcgetpgrp(fd)
Return the process group associated with the terminal given by *fd* (an open
- file descriptor as returned by :func:`open`). Availability: Unix.
+ file descriptor as returned by :func:`os.open`). Availability: Unix.
.. function:: tcsetpgrp(fd, pg)
Set the process group associated with the terminal given by *fd* (an open file
- descriptor as returned by :func:`open`) to *pg*. Availability: Unix.
+ descriptor as returned by :func:`os.open`) to *pg*. Availability: Unix.
.. function:: ttyname(fd)
@@ -667,13 +667,13 @@ by file descriptors.
.. note::
This function is intended for low-level I/O and must be applied to a file
- descriptor as returned by :func:`open` or :func:`pipe`. To write a "file
+ descriptor as returned by :func:`os.open` or :func:`pipe`. To write a "file
object" returned by the built-in function :func:`open` or by :func:`popen` or
- :func:`fdopen`, or :data:`sys.stdout` or :data:`sys.stderr`, use its :meth:`write`
- method.
+ :func:`fdopen`, or :data:`sys.stdout` or :data:`sys.stderr`, use its
+ :meth:`~file.write` method.
The following constants are options for the *flags* parameter to the
-:func:`open` function. They can be combined using the bitwise OR operator
+:func:`~os.open` function. They can be combined using the bitwise OR operator
``|``. Some of them are not available on all platforms. For descriptions of
their availability and use, consult the :manpage:`open(2)` manual page on Unix
or `the MSDN <http://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>` on Windows.
@@ -752,7 +752,7 @@ Files and Directories
.. note::
Using :func:`access` to check if a user is authorized to e.g. open a file before
- actually doing so using :func:`open` creates a security hole, because the user
+ actually doing so using :func:`open` creates a security hole, because the user
might exploit the short time interval between checking and opening the file to
manipulate it.