summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libos.tex
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2000-05-01 16:18:22 (GMT)
committerBarry Warsaw <barry@python.org>2000-05-01 16:18:22 (GMT)
commit93a8eacde559ef3fd910f80f59208054ff99dab9 (patch)
tree75d9d6ee62dca7e3c8c06d94fa04db720b39c661 /Doc/lib/libos.tex
parentd58c26fec6a8e3e33b8337c5e002c28f6f26e42d (diff)
downloadcpython-93a8eacde559ef3fd910f80f59208054ff99dab9.zip
cpython-93a8eacde559ef3fd910f80f59208054ff99dab9.tar.gz
cpython-93a8eacde559ef3fd910f80f59208054ff99dab9.tar.bz2
Document the new additional signature for utime(). In addition to the
previous functionality utime(path, (atime, mtime)), now allowed is utime(path, None) which sets the file's times to the current time.
Diffstat (limited to 'Doc/lib/libos.tex')
-rw-r--r--Doc/lib/libos.tex9
1 files changed, 6 insertions, 3 deletions
diff --git a/Doc/lib/libos.tex b/Doc/lib/libos.tex
index 4001447..0fb8f10 100644
--- a/Doc/lib/libos.tex
+++ b/Doc/lib/libos.tex
@@ -702,9 +702,12 @@ Remove the file \var{path}. This is the same function as
Availability: Macintosh, \UNIX{}, Windows.
\end{funcdesc}
-\begin{funcdesc}{utime}{path, (atime, mtime)}
-Set the access and modified time of the file to the given values.
-(The second argument is a tuple of two items.)
+\begin{funcdesc}{utime}{path, times}
+Set the access and modified times of the file specified by \var{path}.
+If \var{times} is \code{None}, then the file's access and modified
+times are set to the current time. Otherwise, \var{times} must be a
+2-tuple of numbers, of the form \var{(atime, mtime)} which is used to
+set the access and modified times, respectively.
Availability: Macintosh, \UNIX{}, Windows.
\end{funcdesc}