summaryrefslogtreecommitdiffstats
path: root/python
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2009-06-24 19:57:24 +0100
committerRichard W.M. Jones <rjones@redhat.com>2009-06-24 19:57:24 +0100
commitda947eadcfa1367c2d634667068db813a87a6dd1 (patch)
tree8d92e6340cb2d0c587b9a242633f5576405e6e19 /python
parent0574eab8bc7d8e72db862ec36815835938a5fdf1 (diff)
downloadlibguestfs-da947eadcfa1367c2d634667068db813a87a6dd1.tar.gz
libguestfs-da947eadcfa1367c2d634667068db813a87a6dd1.tar.xz
libguestfs-da947eadcfa1367c2d634667068db813a87a6dd1.zip
Clarify documentation for mkdtemp.
Diffstat (limited to 'python')
-rw-r--r--python/guestfs.py12
1 files changed, 8 insertions, 4 deletions
diff --git a/python/guestfs.py b/python/guestfs.py
index fec12a71..23aef9c2 100644
--- a/python/guestfs.py
+++ b/python/guestfs.py
@@ -1707,15 +1707,19 @@ class GuestFS:
def mkdtemp (self, template):
u"""This command creates a temporary directory. The
"template" parameter should be a full pathname for the
- temporary directory with the six characters being
- "XXXXXX".
+ temporary directory name with the final six characters
+ being "XXXXXX".
- For example: "/tmp/tmpXXXXXX" or "/Temp/tmpXXXXXX", the
- second one being suitable for Windows.
+ For example: "/tmp/myprogXXXXXX" or
+ "/Temp/myprogXXXXXX", the second one being suitable for
+ Windows filesystems.
The name of the temporary directory that was created is
returned.
+ The temporary directory is created with mode 0700 and is
+ owned by root.
+
The caller is responsible for deleting the temporary
directory and its contents after use.