Test that the thread destructors are executed before global destruction

[perl/modules/Thread-Cleanup.git] / README

diff --git a/README b/README
index 5f67483663e81302c306c775b9e453abf882bde1..d3ebe0be6c9bbdcb1e73fa14858a487d57647cc1 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     Thread::Cleanup - Hook thread destruction.
 
 VERSION
-    Version 0.02
+    Version 0.05
 
 SYNOPSIS
         use Thread::Cleanup;
@@ -22,14 +22,18 @@ DESCRIPTION
     program, with the exception of the main thread.
 
 FUNCTIONS
-  "register BLOCK"
-    Specify that the "BLOCK" will have to be called (in void context,
-    without arguments) every time a thread finishes is job. More precisely,
+  "register"
+        register { ... };
+        &register($coderef);
 
-    *   it will always be called before the join for joined threads ;
+    Specify that the given block or code reference $coderef will have to be
+    called (in void context, without arguments) every time a thread finishes
+    its job. More precisely,
 
-    *   it will be called for detached threads only if they terminate before
-        the main thread, and the hook will then fire at "END" time ;
+    *   it will always be called before the joining for joined threads ;
+
+    *   it will be called for detached threads if and only if they terminate
+        before the main thread, and the hook will then fire at "END" time ;
 
     *   it won't trigger for the destruction of the main thread.
 
@@ -39,6 +43,9 @@ EXPORT
 DEPENDENCIES
     perl 5.8.
 
+    A C compiler. This module may happen to build with a C++ compiler as
+    well, but don't rely on it, as no guarantee is made in this regard.
+
     threads 1.07.
 
     XSLoader.
@@ -62,7 +69,7 @@ ACKNOWLEDGEMENTS
     Inspired by a question from TonyC on #p5p.
 
 COPYRIGHT & LICENSE
-    Copyright 2009 Vincent Pit, all rights reserved.
+    Copyright 2009,2010,2013 Vincent Pit, all rights reserved.
 
     This program is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.