This is 0.06

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

diff --git a/README b/README
index d3ebe0be6c9bbdcb1e73fa14858a487d57647cc1..5d33e42cd636933fd06b5b09093fe2b923a725de 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     Thread::Cleanup - Hook thread destruction.
 
 VERSION
     Thread::Cleanup - Hook thread destruction.
 
 VERSION

-    Version 0.05
+    Version 0.06

 
 SYNOPSIS
         use Thread::Cleanup;
 
 SYNOPSIS
         use Thread::Cleanup;


@@ -21,21 +21,30 @@ DESCRIPTION
     It acts globally on all the threads that may spawn anywhere in your
     program, with the exception of the main thread.
 
     It acts globally on all the threads that may spawn anywhere in your
     program, with the exception of the main thread.
 

+    The hook will also be called when pseudo-forks (i.e. processes spawn on
+    Windows for the "fork" emulation) terminate.
+

 FUNCTIONS
   "register"
         register { ... };
         &register($coderef);
 
     Specify that the given block or code reference $coderef will have to be
 FUNCTIONS
   "register"
         register { ... };
         &register($coderef);
 
     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,
+    called (in void context, without arguments) every time a thread or a
+    pseudo-fork terminates. More precisely :
+
+    *   For joined threads, it will be called when "join" succeeds, after
+        any "END" block local to the spawn thread ;

 
 

-    *   it will always be called before the joining for joined threads ;
+    *   For detached threads, it will be called if and only if the thread
+        terminates before the main thread, and the hook will then fire at
+        global "END" time ;

 
 

-    *   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 ;
+    *   For pseudo-forks, it will be called when "waitpid" succeeds, after
+        any "END" block local to the spawn process but before any global
+        "END" block ;

 
 

-    *   it won't trigger for the destruction of the main thread.
+    *   It will never trigger for the destruction of the main thread.

 
 EXPORT
     None.
 
 EXPORT
     None.


@@ -69,7 +78,7 @@ ACKNOWLEDGEMENTS
     Inspired by a question from TonyC on #p5p.
 
 COPYRIGHT & LICENSE
     Inspired by a question from TonyC on #p5p.
 
 COPYRIGHT & LICENSE

-    Copyright 2009,2010,2013 Vincent Pit, all rights reserved.
+    Copyright 2009,2010,2013,2014 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.
 
     This program is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.