From da947eadcfa1367c2d634667068db813a87a6dd1 Mon Sep 17 00:00:00 2001
From: "Richard W.M. Jones" <rjones@redhat.com>
Date: Wed, 24 Jun 2009 19:57:24 +0100
Subject: [PATCH] Clarify documentation for mkdtemp.

---
 fish/cmds.c                                |  2 +-
 guestfish-actions.pod                      |  9 ++++++---
 guestfs-actions.pod                        |  9 ++++++---
 java/com/redhat/et/libguestfs/GuestFS.java | 12 ++++++++----
 perl/lib/Sys/Guestfs.pm                    |  9 ++++++---
 python/guestfs.py                          | 12 ++++++++----
 src/generator.ml                           |  9 ++++++---
 7 files changed, 41 insertions(+), 21 deletions(-)

diff --git a/fish/cmds.c b/fish/cmds.c
index 46d6736..e803e89 100644
--- a/fish/cmds.c
+++ b/fish/cmds.c
@@ -586,7 +586,7 @@ void display_command (const char *cmd)
     pod2text ("scrub-freespace - scrub (securely wipe) free space", " scrub-freespace <dir>\n\nThis command creates the directory C<dir> and then fills it\nwith files until the filesystem is full, and scrubs the files\nas for C<scrub_file>, and deletes them.\nThe intention is to scrub any free space on the partition\ncontaining C<dir>.\n\nIt is an interface to the L<scrub(1)> program.  See that\nmanual page for more details.");
   else
   if (strcasecmp (cmd, "mkdtemp") == 0)
-    pod2text ("mkdtemp - create a temporary directory", " mkdtemp <template>\n\nThis command creates a temporary directory.  The\nC<template> parameter should be a full pathname for the\ntemporary directory with the six characters being\n\"XXXXXX\".\n\nFor example: \"/tmp/tmpXXXXXX\" or \"/Temp/tmpXXXXXX\",\nthe second one being suitable for Windows.\n\nThe name of the temporary directory that was created\nis returned.\n\nThe caller is responsible for deleting the temporary\ndirectory and its contents after use.\n\nSee also: L<mkdtemp(3)>");
+    pod2text ("mkdtemp - create a temporary directory", " mkdtemp <template>\n\nThis command creates a temporary directory.  The\nC<template> parameter should be a full pathname for the\ntemporary directory name with the final six characters being\n\"XXXXXX\".\n\nFor example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",\nthe second one being suitable for Windows filesystems.\n\nThe name of the temporary directory that was created\nis returned.\n\nThe temporary directory is created with mode 0700\nand is owned by root.\n\nThe caller is responsible for deleting the temporary\ndirectory and its contents after use.\n\nSee also: L<mkdtemp(3)>");
   else
     display_builtin_command (cmd);
 }
diff --git a/guestfish-actions.pod b/guestfish-actions.pod
index eee402c..e21dc7b 100644
--- a/guestfish-actions.pod
+++ b/guestfish-actions.pod
@@ -913,15 +913,18 @@ as necessary.  This is like the C<mkdir -p> shell command.
 
 This command creates a temporary directory.  The
 C<template> parameter should be a full pathname for the
-temporary directory with the six characters being
+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.
 
diff --git a/guestfs-actions.pod b/guestfs-actions.pod
index 82746a5..755479f 100644
--- a/guestfs-actions.pod
+++ b/guestfs-actions.pod
@@ -1198,15 +1198,18 @@ This function returns 0 on success or -1 on error.
 
 This command creates a temporary directory.  The
 C<template> parameter should be a full pathname for the
-temporary directory with the six characters being
+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.
 
diff --git a/java/com/redhat/et/libguestfs/GuestFS.java b/java/com/redhat/et/libguestfs/GuestFS.java
index dff2373..c664801 100644
--- a/java/com/redhat/et/libguestfs/GuestFS.java
+++ b/java/com/redhat/et/libguestfs/GuestFS.java
@@ -3539,15 +3539,19 @@ public HashMap<String,String> test0rhashtableerr ()
    * <p>
    * 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".
    * <p>
-   * 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.
    * <p>
    * The name of the temporary directory that was created is
    * returned.
    * <p>
+   * The temporary directory is created with mode 0700 and is
+   * owned by root.
+   * <p>
    * The caller is responsible for deleting the temporary
    * directory and its contents after use.
    * <p>
diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm
index bd2a80c..83fbbb1 100644
--- a/perl/lib/Sys/Guestfs.pm
+++ b/perl/lib/Sys/Guestfs.pm
@@ -856,15 +856,18 @@ as necessary.  This is like the C<mkdir -p> shell command.
 
 This command creates a temporary directory.  The
 C<template> parameter should be a full pathname for the
-temporary directory with the six characters being
+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.
 
diff --git a/python/guestfs.py b/python/guestfs.py
index fec12a7..23aef9c 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.
         
diff --git a/src/generator.ml b/src/generator.ml
index e378395..86f2fe2 100755
--- a/src/generator.ml
+++ b/src/generator.ml
@@ -2450,15 +2450,18 @@ manual page for more details.");
    "\
 This command creates a temporary directory.  The
 C<template> parameter should be a full pathname for the
-temporary directory with the six characters being
+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.
 
-- 
1.8.3.1