Mercurial > hg > octave-nkf > gnulib-hg

changeset 15282:5b5b1669e3d4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
clean-temp: Improve documentation. * lib/clean-temp.h: Explain better how to use this module. Reported by John Darrington <john@darrington.wattle.id.au>.
author Bruno Haible <bruno@clisp.org>
date Sat, 18 Jun 2011 11:25:17 +0200
parents 7be11eb972c2
children c0393c370200
files ChangeLog lib/clean-temp.h
diffstat 2 files changed, 12 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2011-06-18  Bruno Haible  <bruno@clisp.org>
+
+	clean-temp: Improve documentation.
+	* lib/clean-temp.h: Explain better how to use this module.
+	Reported by John Darrington <john@darrington.wattle.id.au>.
+
 2011-06-17  Bruno Haible  <bruno@clisp.org>
 
 	pread, pwrite: Avoid cc warning on AIX.
--- a/lib/clean-temp.h
+++ b/lib/clean-temp.h
@@ -43,7 +43,12 @@
    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.  */
+   SIGBUS, SIGILL, SIGFPE.
+
+   For the cleanup in the normal case, programs that use this module need to
+   call 'cleanup_temp_dir' for each successful return of 'create_temp_dir'.
+   The cleanup in the case of a fatal signal such as SIGINT, SIGTERM, SIGHUP,
+   is done entirely automatically by the functions of this module.  */
 
 struct temp_dir
 {