From 5ea8bedd0c6a7a8f29dcff301d126b58cc123ea8 Mon Sep 17 00:00:00 2001 From: Bruno Haible Date: Wed, 27 Apr 2011 23:28:48 +0200 Subject: [PATCH] clean-temp: Clarify what it does. * lib/clean-temp.h: Add more comments. * doc/posix-functions/mkstemp.texi: Tweak reference to 'clean-temp' module. * doc/glibc-functions/mkostemp.texi: Mention 'clean-temp' here too. * doc/glibc-functions/mkstemps.texi: Likewise. * doc/glibc-functions/mkostemps.texi: Likewise. --- ChangeLog | 10 ++++++++++ doc/glibc-functions/mkostemp.texi | 3 +++ doc/glibc-functions/mkostemps.texi | 3 +++ doc/glibc-functions/mkstemps.texi | 3 +++ doc/posix-functions/mkstemp.texi | 4 ++-- lib/clean-temp.h | 8 ++++++-- 6 files changed, 27 insertions(+), 4 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2dbf3cfa8d..6dcaa38f89 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,13 @@ +2011-04-27 Bruno Haible + + clean-temp: Clarify what it does. + * lib/clean-temp.h: Add more comments. + * doc/posix-functions/mkstemp.texi: Tweak reference to 'clean-temp' + module. + * doc/glibc-functions/mkostemp.texi: Mention 'clean-temp' here too. + * doc/glibc-functions/mkstemps.texi: Likewise. + * doc/glibc-functions/mkostemps.texi: Likewise. + 2011-04-27 Eric Blake fchdir: avoid extra chdir and fix test diff --git a/doc/glibc-functions/mkostemp.texi b/doc/glibc-functions/mkostemp.texi index ff1db30817..44e3ab3138 100644 --- a/doc/glibc-functions/mkostemp.texi +++ b/doc/glibc-functions/mkostemp.texi @@ -15,3 +15,6 @@ IRIX 6.5, OSF/1 5.1, Solaris 11 2010-11, Cygwin 1.7.5, mingw, Interix 3.5, BeOS. Portability problems not fixed by Gnulib: @itemize @end itemize + +The gnulib module @code{clean-temp} can create temporary files that will not +be left behind after signals such as SIGINT. diff --git a/doc/glibc-functions/mkostemps.texi b/doc/glibc-functions/mkostemps.texi index b847fae925..033d462c77 100644 --- a/doc/glibc-functions/mkostemps.texi +++ b/doc/glibc-functions/mkostemps.texi @@ -15,3 +15,6 @@ glibc 2.10, MacOS X 10.5, FreeBSD 6.0, NetBSD 5.0, OpenBSD 3.8, AIX Portability problems not fixed by Gnulib: @itemize @end itemize + +The gnulib module @code{clean-temp} can create temporary files that will not +be left behind after signals such as SIGINT. diff --git a/doc/glibc-functions/mkstemps.texi b/doc/glibc-functions/mkstemps.texi index a321a49800..2c49d410c0 100644 --- a/doc/glibc-functions/mkstemps.texi +++ b/doc/glibc-functions/mkstemps.texi @@ -15,3 +15,6 @@ glibc 2.10, AIX 5.1, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 10, Cygwin Portability problems not fixed by Gnulib: @itemize @end itemize + +The gnulib module @code{clean-temp} can create temporary files that will not +be left behind after signals such as SIGINT. diff --git a/doc/posix-functions/mkstemp.texi b/doc/posix-functions/mkstemp.texi index 5f62b44bc3..60e83e99f7 100644 --- a/doc/posix-functions/mkstemp.texi +++ b/doc/posix-functions/mkstemp.texi @@ -25,5 +25,5 @@ Portability problems not fixed by Gnulib: @itemize @end itemize -The gnulib module clean-temp can create temporary files that are less -likely to be left behind on signals such as SIGINT. +The gnulib module @code{clean-temp} can create temporary files that will not +be left behind after signals such as SIGINT. diff --git a/lib/clean-temp.h b/lib/clean-temp.h index 07c45ab22d..cac0702065 100644 --- a/lib/clean-temp.h +++ b/lib/clean-temp.h @@ -1,5 +1,5 @@ /* Temporary directories and temporary files with automatic cleanup. - Copyright (C) 2006, 2009-2011 Free Software Foundation, Inc. + Copyright (C) 2006, 2011 Free Software Foundation, Inc. Written by Bruno Haible , 2006. This program is free software: you can redistribute it and/or modify @@ -39,7 +39,11 @@ extern "C" { This module provides support for temporary directories and temporary files inside these temporary directories. Temporary files without temporary - directories are not supported here. */ + directories are not supported here. The temporary directories and files + 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, */ struct temp_dir { -- 2.30.2