# HG changeset patch
# User Bruno Haible <bruno@clisp.org>
# Date 1303939728 -7200
# Node ID e38cec555642d9aea7d3d71a205fbfdf54d2a784
# Parent  3b510b174c56cb851dc5c7934dcb62b803009f53
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
--- 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
--- a/doc/glibc-functions/mkostemp.texi
+++ b/doc/glibc-functions/mkostemp.texi
@@ -15,3 +15,6 @@
 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
--- a/doc/glibc-functions/mkostemps.texi
+++ b/doc/glibc-functions/mkostemps.texi
@@ -15,3 +15,6 @@
 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
--- a/doc/glibc-functions/mkstemps.texi
+++ b/doc/glibc-functions/mkstemps.texi
@@ -15,3 +15,6 @@
 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
--- a/doc/posix-functions/mkstemp.texi
+++ b/doc/posix-functions/mkstemp.texi
@@ -25,5 +25,5 @@
 @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
--- 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 @@
 
    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
 {