From 8d31711c57dba0cc1a1f579ed2d59b94bbe39176 Mon Sep 17 00:00:00 2001 From: Bruno Haible Date: Sat, 18 Jun 2011 11:25:17 +0200 Subject: [PATCH] clean-temp: Improve documentation. * lib/clean-temp.h: Explain better how to use this module. Reported by John Darrington . --- ChangeLog | 6 ++++++ lib/clean-temp.h | 7 ++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/ChangeLog b/ChangeLog index e77dd85e3..6e4a01655 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2011-06-18 Bruno Haible + + clean-temp: Improve documentation. + * lib/clean-temp.h: Explain better how to use this module. + Reported by John Darrington . + 2011-06-17 Bruno Haible pread, pwrite: Avoid cc warning on AIX. diff --git a/lib/clean-temp.h b/lib/clean-temp.h index 8a0774dca..7015e21b2 100644 --- 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 { -- 2.11.0