Support pseudo-forks more reliably

[perl/modules/Thread-Cleanup.git] / lib / Thread / Cleanup.pm

diff --git a/lib/Thread/Cleanup.pm b/lib/Thread/Cleanup.pm
index a05fd7b537f9b330d45706598210633886004dc0..96256fd4ea227484a841e01d07da822884123b71 100644 (file)
--- a/lib/Thread/Cleanup.pm
+++ b/lib/Thread/Cleanup.pm
@@ -11,14 +11,14 @@ Thread::Cleanup - Hook thread destruction.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.05
 
 =cut
 
 our $VERSION;
 
 BEGIN {
- $VERSION = '0.01';
+ $VERSION = '0.05';
  require XSLoader;
  XSLoader::load(__PACKAGE__, $VERSION);
 }
@@ -40,22 +40,27 @@ This module allows you to hook thread destruction without fiddling with the inte
 
 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 C<fork> emulation) terminate.
+
 =head1 FUNCTIONS
 
-=head2 C<register BLOCK>
+=head2 C<register>
+
+    register { ... };
+    &register($coderef);
 
-Specify that the C<BLOCK> will have to be called (in void context, without arguments) every time a thread finishes is job.
+Specify that the given block or code reference C<$coderef> will have to be called (in void context, without arguments) every time a thread finishes its job.
 More precisely,
 
 =over 4
 
 =item *
 
-it will always be called before the join for joined threads ;
+it will always be called before the joining for joined threads ;
 
 =item *
 
-it will be called for detached threads only if they terminate before the main thread, and the hook will then fire at C<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 C<END> time ;
 
 =item *
 
@@ -79,6 +84,9 @@ None.
 
 L<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.
+
 L<threads> 1.07.
 
 L<XSLoader>.
@@ -103,7 +111,7 @@ Inspired by a question from TonyC on #p5p.
 
 =head1 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.