summaryrefslogtreecommitdiffstats
path: root/Doc/library/os.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-09-01 08:11:14 (GMT)
committerGeorg Brandl <georg@python.org>2009-09-01 08:11:14 (GMT)
commita6053b4846e575ebf4be89d6b2c4a7335fee8ccb (patch)
tree716d5d660eb2f44346d9a54645d4c828e0774eec /Doc/library/os.rst
parent2c52e2fa854a5fdf8f987e89271b54128f515b1f (diff)
downloadcpython-a6053b4846e575ebf4be89d6b2c4a7335fee8ccb.zip
cpython-a6053b4846e575ebf4be89d6b2c4a7335fee8ccb.tar.gz
cpython-a6053b4846e575ebf4be89d6b2c4a7335fee8ccb.tar.bz2
Merged revisions 74542,74544-74548,74550,74554-74555,74578,74588,74590,74603,74616-74618,74621 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r74542 | georg.brandl | 2009-08-23 23:28:56 +0200 (So, 23 Aug 2009) | 1 line Restore alphabetic order. ........ r74544 | georg.brandl | 2009-08-24 19:12:30 +0200 (Mo, 24 Aug 2009) | 1 line #6775: fix python.org URLs in README. ........ r74545 | georg.brandl | 2009-08-24 19:14:29 +0200 (Mo, 24 Aug 2009) | 1 line #6772: mention utf-8 as utf8 alias. ........ r74546 | georg.brandl | 2009-08-24 19:20:40 +0200 (Mo, 24 Aug 2009) | 1 line #6725: spell "namespace" consistently. ........ r74547 | georg.brandl | 2009-08-24 19:22:05 +0200 (Mo, 24 Aug 2009) | 1 line #6718: fix example. ........ r74548 | georg.brandl | 2009-08-24 19:24:27 +0200 (Mo, 24 Aug 2009) | 1 line #6677: mention "deleting" as an alias for removing files. ........ r74550 | georg.brandl | 2009-08-24 19:48:40 +0200 (Mo, 24 Aug 2009) | 1 line #6677: note that rmdir only removes empty directories. ........ r74554 | georg.brandl | 2009-08-27 20:59:02 +0200 (Do, 27 Aug 2009) | 1 line Typo fix. ........ r74555 | georg.brandl | 2009-08-27 21:02:43 +0200 (Do, 27 Aug 2009) | 1 line #6787: reference fix. ........ r74578 | tarek.ziade | 2009-08-29 15:33:21 +0200 (Sa, 29 Aug 2009) | 1 line fixed #6801: symmetric_difference_update also accepts pipe ........ r74588 | georg.brandl | 2009-08-30 10:35:01 +0200 (So, 30 Aug 2009) | 1 line #6803: fix old name. ........ r74590 | georg.brandl | 2009-08-30 13:51:53 +0200 (So, 30 Aug 2009) | 1 line #6801: fix copy-paste oversight. ........ r74603 | georg.brandl | 2009-08-31 08:38:29 +0200 (Mo, 31 Aug 2009) | 1 line other -> others where multiple arguments are accepted. ........ r74616 | georg.brandl | 2009-09-01 09:46:26 +0200 (Di, 01 Sep 2009) | 1 line #6808: clarification. ........ r74617 | georg.brandl | 2009-09-01 09:53:37 +0200 (Di, 01 Sep 2009) | 1 line #6765: hint that log(x, base) is not very sophisticated. ........ r74618 | georg.brandl | 2009-09-01 10:00:47 +0200 (Di, 01 Sep 2009) | 1 line #6810: add a link to the section about frame objects instead of just a description where to find it. ........ r74621 | georg.brandl | 2009-09-01 10:06:03 +0200 (Di, 01 Sep 2009) | 1 line #6638: fix wrong parameter name and markup a class. ........
Diffstat (limited to 'Doc/library/os.rst')
-rw-r--r--Doc/library/os.rst23
1 files changed, 13 insertions, 10 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 2548b70..9bed1ce 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -947,12 +947,12 @@ Files and Directories
.. function:: remove(path)
- Remove the file *path*. If *path* is a directory, :exc:`OSError` is raised; see
- :func:`rmdir` below to remove a directory. This is identical to the
- :func:`unlink` function documented below. On Windows, attempting to remove a
- file that is in use causes an exception to be raised; on Unix, the directory
- entry is removed but the storage allocated to the file is not made available
- until the original file is no longer in use. Availability: Unix,
+ Remove (delete) the file *path*. If *path* is a directory, :exc:`OSError` is
+ raised; see :func:`rmdir` below to remove a directory. This is identical to
+ the :func:`unlink` function documented below. On Windows, attempting to
+ remove a file that is in use causes an exception to be raised; on Unix, the
+ directory entry is removed but the storage allocated to the file is not made
+ available until the original file is no longer in use. Availability: Unix,
Windows.
@@ -997,7 +997,10 @@ Files and Directories
.. function:: rmdir(path)
- Remove the directory *path*. Availability: Unix, Windows.
+ Remove (delete) the directory *path*. Only works when the directory is
+ empty, otherwise, :exc:`OSError` is raised. In order to remove whole
+ directory trees, :func:`shutil.rmtree` can be used. Availability: Unix,
+ Windows.
.. function:: stat(path)
@@ -1099,9 +1102,9 @@ Files and Directories
.. function:: unlink(path)
- Remove the file *path*. This is the same function as :func:`remove`; the
- :func:`unlink` name is its traditional Unix name. Availability: Unix,
- Windows.
+ Remove (delete) the file *path*. This is the same function as
+ :func:`remove`; the :func:`unlink` name is its traditional Unix
+ name. Availability: Unix, Windows.
.. function:: utime(path, times)