]> Savannah Git Hosting - gnulib.git/commitdiff
clean-temp: Document limitations.
authorBruno Haible <bruno@clisp.org>
Sat, 4 Jul 2020 13:22:33 +0000 (15:22 +0200)
committerBruno Haible <bruno@clisp.org>
Sat, 4 Jul 2020 13:22:33 +0000 (15:22 +0200)
* lib/clean-temp.h: Document limitations.

ChangeLog
lib/clean-temp.h

index 0b488710f91a99a883b7851ffdee6d2c5a531550..8e0408c019940bf5b27c8db64433575fc6c7454e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2020-07-04  Bruno Haible  <bruno@clisp.org>
+
+       clean-temp: Document limitations.
+       * lib/clean-temp.h: Document limitations.
+
 2020-07-04  Bruno Haible  <bruno@clisp.org>
 
        clean-temp: Add support for temporary files with unpredictable names.
index 087db452d1e3c875f224dc4b1917bce68f4d1930..df7e7442c057f4b1c94b3af2b8b7798dea373761 100644 (file)
@@ -49,7 +49,17 @@ extern "C" {
    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.  */
+   is done entirely automatically by the functions of this module.
+
+   Limitations: Files or directories can still be left over if
+     - the program is dies from a fatal signal such as SIGQUIT, SIGKILL, or
+       SIGABRT, SIGSEGV, SIGBUS, SIGILL, SIGFPE, or
+     - in a multithreaded program, the fatal signal handler is already running
+       while another thread of the program creates a new temporary directory
+       or temporary file, or
+     - on native Windows, some temporary files are used by a subprocess while
+       the fatal signal interrupts the program.
+ */
 
 
 /* ============= Temporary files without temporary directories ============= */