clean-temp: Clarify what it does.

* lib/clean-temp.h: Add more comments.
* doc/posix-functions/mkstemp.texi: Tweak reference to 'clean-temp'
module.
* doc/glibc-functions/mkostemp.texi: Mention 'clean-temp' here too.
* doc/glibc-functions/mkstemps.texi: Likewise.
* doc/glibc-functions/mkostemps.texi: Likewise.

diff --git a/ChangeLog b/ChangeLog
index 2dbf3cfa8db5858b47f6eb36e34ecff958cc3ba5..6dcaa38f89569afbd4a463507ad8ec0de067e57c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2011-04-27  Bruno Haible  <bruno@clisp.org>
+
+       clean-temp: Clarify what it does.
+       * lib/clean-temp.h: Add more comments.
+       * doc/posix-functions/mkstemp.texi: Tweak reference to 'clean-temp'
+       module.
+       * doc/glibc-functions/mkostemp.texi: Mention 'clean-temp' here too.
+       * doc/glibc-functions/mkstemps.texi: Likewise.
+       * doc/glibc-functions/mkostemps.texi: Likewise.
+
 2011-04-27  Eric Blake  <eblake@redhat.com>
 
        fchdir: avoid extra chdir and fix test

diff --git a/doc/glibc-functions/mkostemp.texi b/doc/glibc-functions/mkostemp.texi
index ff1db308173280085aab223ff45399b7c8c3e02a..44e3ab31383e051ea43fdb7ca02806c0a64d350b 100644 (file)
--- a/doc/glibc-functions/mkostemp.texi
+++ b/doc/glibc-functions/mkostemp.texi
@@ -15,3 +15,6 @@ IRIX 6.5, OSF/1 5.1, Solaris 11 2010-11, Cygwin 1.7.5, mingw, Interix 3.5, BeOS.
 Portability problems not fixed by Gnulib:
 @itemize
 @end itemize
+
+The gnulib module @code{clean-temp} can create temporary files that will not
+be left behind after signals such as SIGINT.

diff --git a/doc/glibc-functions/mkostemps.texi b/doc/glibc-functions/mkostemps.texi
index b847fae92535eed199d3f1d14bef9b5e97e8dfb8..033d462c77939df38c0213d09aa771a4b674f89d 100644 (file)
--- a/doc/glibc-functions/mkostemps.texi
+++ b/doc/glibc-functions/mkostemps.texi
@@ -15,3 +15,6 @@ glibc 2.10, MacOS X 10.5, FreeBSD 6.0, NetBSD 5.0, OpenBSD 3.8, AIX
 Portability problems not fixed by Gnulib:
 @itemize
 @end itemize
+
+The gnulib module @code{clean-temp} can create temporary files that will not
+be left behind after signals such as SIGINT.

diff --git a/doc/glibc-functions/mkstemps.texi b/doc/glibc-functions/mkstemps.texi
index a321a49800043b1131928092892155e571c5b613..2c49d410c0391c5cf60962dd2b839631f50b0062 100644 (file)
--- a/doc/glibc-functions/mkstemps.texi
+++ b/doc/glibc-functions/mkstemps.texi
@@ -15,3 +15,6 @@ glibc 2.10, AIX 5.1, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 10, Cygwin
 Portability problems not fixed by Gnulib:
 @itemize
 @end itemize
+
+The gnulib module @code{clean-temp} can create temporary files that will not
+be left behind after signals such as SIGINT.

diff --git a/doc/posix-functions/mkstemp.texi b/doc/posix-functions/mkstemp.texi
index 5f62b44bc33cdecd66092c1f4de84421fca0bc9f..60e83e99f76a55aebc1b3fac129c1d91ec48a540 100644 (file)
--- a/doc/posix-functions/mkstemp.texi
+++ b/doc/posix-functions/mkstemp.texi
@@ -25,5 +25,5 @@ Portability problems not fixed by Gnulib:
 @itemize
 @end itemize
 
-The gnulib module clean-temp can create temporary files that are less
-likely to be left behind on signals such as SIGINT.
+The gnulib module @code{clean-temp} can create temporary files that will not
+be left behind after signals such as SIGINT.

diff --git a/lib/clean-temp.h b/lib/clean-temp.h
index 07c45ab22dbde6053c444207537d70a3f6ffc938..cac0702065d64652804a67b80b40c87ecdfdb564 100644 (file)
--- a/lib/clean-temp.h
+++ b/lib/clean-temp.h
@@ -1,5 +1,5 @@
 /* Temporary directories and temporary files with automatic cleanup.
-   Copyright (C) 2006, 2009-2011 Free Software Foundation, Inc.
+   Copyright (C) 2006, 2011 Free Software Foundation, Inc.
    Written by Bruno Haible <bruno@clisp.org>, 2006.
 
    This program is free software: you can redistribute it and/or modify
@@ -39,7 +39,11 @@ extern "C" {
 
    This module provides support for temporary directories and temporary files
    inside these temporary directories.  Temporary files without temporary
-   directories are not supported here.  */
+   directories are not supported here.  The temporary directories and files
+   are automatically cleaned up (at the latest) when the program exits or
+   dies from a fatal signal such as SIGINT, SIGTERM, SIGHUP, but not if it
+   dies from a fatal signal such as SIGQUIT, SIGKILL, or SIGABRT, SIGSEGV,
+   SIGBUS, SIGILL, SIGFPE,  */
 
 struct temp_dir
 {