mkstemp: mention clean-temp module

* lib/mkstemp.c: Add comment.
* doc/posix-functions/mkstemp.texi (mkstemp): Likewise.

Signed-off-by: Eric Blake <eblake@redhat.com>

diff --git a/ChangeLog b/ChangeLog
index 248d0f399a98622715cbf688d7b1b03333c0a35b..247d541df0fae34a90a9eaab8983690f6095b68f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2011-04-27  Reuben Thomas  <rrt@sc3d.org>
+       and Eric Blake  <eblake@redhat.com>
+
+       mkstemp: mention clean-temp module
+       * lib/mkstemp.c: Add comment.
+       * doc/posix-functions/mkstemp.texi (mkstemp): Likewise.
+
 2011-04-26  Paul Eggert  <eggert@cs.ucla.edu>
 
        inttypes: also provide default values for 32-bit tests

diff --git a/doc/posix-functions/mkstemp.texi b/doc/posix-functions/mkstemp.texi
index 55b42a9feb0bad3a5ccfec77cd251ce62f27a50e..5a1e145600a971fe512a182812ff75d8b089e6ce 100644 (file)
--- a/doc/posix-functions/mkstemp.texi
+++ b/doc/posix-functions/mkstemp.texi
@@ -24,3 +24,6 @@ On platforms other than glibc 2.0.7 or newer, @code{mkstemp} can create a
 world or group writable or readable file, if you haven't set the process
 umask to 077.  This is a security risk.
 @end itemize
+
+The gnulib module clean-temp can create temporary files that are less
+likely to be left behind on signals such as SIGINT.

diff --git a/lib/mkstemp.c b/lib/mkstemp.c
index b0a8df306a3030193d948c16dc837b5b3a32179c..3c8437e5a42c1f72ca22a2516ead079f97295a06 100644 (file)
--- a/lib/mkstemp.c
+++ b/lib/mkstemp.c
@@ -38,7 +38,11 @@
 /* Generate a unique temporary file name from XTEMPLATE.
    The last six characters of XTEMPLATE must be "XXXXXX";
    they are replaced with a string that makes the file name unique.
-   Then open the file and return a fd. */
+   Then open the file and return a fd.
+
+   If you are creating temporary files which will later be removed,
+   consider using the clean-temp module, which avoids several pitfalls
+   of using mkstemp directly. */
 int
 mkstemp (char *xtemplate)
 {