clean-temp: Improve documentation.

* lib/clean-temp.h: Explain better how to use this module.
Reported by John Darrington <john@darrington.wattle.id.au>.

diff --git a/ChangeLog b/ChangeLog
index e77dd85..6e4a016 100644 (file)
--- 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.

diff --git a/lib/clean-temp.h b/lib/clean-temp.h
index 8a0774d..7015e21 100644 (file)
--- a/lib/clean-temp.h
+++ b/lib/clean-temp.h
@@ -43,7 +43,12 @@ extern "C" {
    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
 {