X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=lib%2Fclean-temp.h;h=7015e21b266c19590d74b917d52d770910c6156d;hb=8d31711c57dba0cc1a1f579ed2d59b94bbe39176;hp=8a0774dcace6c905b7958ed23997a0141dccf2a5;hpb=b6d3498bc359abfa38966b11184ea6831942efab;p=pspp

diff --git a/lib/clean-temp.h b/lib/clean-temp.h
index 8a0774dcac..7015e21b26 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
 {