This is 0.12

[perl/modules/Lexical-Types.git] / README

diff --git a/README b/README
index 0d8a7a8877fb7c2628f3f1b5e3c5ad2e361d43d3..919e0afe5d8cda6269335e27e72deae4b9c87fbf 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     Lexical::Types - Extend the semantics of typed lexicals.
 
 VERSION
-    Version 0.04
+    Version 0.12
 
 SYNOPSIS
         { package Str; }
@@ -148,7 +148,7 @@ INTEGRATION
 
         sub import {
          my $pkg = caller;
-         for (qw/Str Int/) {
+         for (qw<Str Int>) {
           my $type = __PACKAGE__ . '::' . $_;
           no strict 'refs';
           no warnings 'redefine';
@@ -171,13 +171,17 @@ INTEGRATION
 
         sub new { ... }
 
-CAVEATS
-    For "perl" to be able to parse "my Str $x", you need :
+CONSTANTS
+  "LT_THREADSAFE"
+    True iff the module could have been built with thread-safety features
+    enabled.
 
-    *   either the "Str" package to be defined ;
-
-    *   or for "Str" to be a constant sub returning a valid defined package.
+  "LT_FORKSAFE"
+    True iff this module could have been built with fork-safety features
+    enabled. This will always be true except on Windows where it's false for
+    perl 5.10.0 and below .
 
+CAVEATS
     The restrictions on the type (being either a defined package name or a
     constant) apply even if you use the 'as' option to redirect to another
     package, and are unlikely to find a workaround as this happens deep
@@ -186,8 +190,22 @@ CAVEATS
     Only one mangler or prefix can be in use at the same time in a given
     scope.
 
+    The implementation was tweaked to work around several limitations of
+    vanilla "perl" pragmas : it's thread safe, and doesn't suffer from a
+    "perl 5.8.x-5.10.0" bug that causes all pragmas to propagate into
+    "require"d scopes.
+
+    With 5.8 perls, the pragma does not propagate into "eval STRING". This
+    is due to a shortcoming in the way perl handles the hints hash, which is
+    addressed in perl 5.10.
+
 DEPENDENCIES
-    perl 5.8, XSLoader.
+    perl 5.8.3.
+
+    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.
+
+    XSLoader (standard since perl 5.006).
 
 SEE ALSO
     fields.
@@ -220,7 +238,7 @@ ACKNOWLEDGEMENTS
     Thanks Florian Ragwitz for suggesting the use of constants for types.
 
 COPYRIGHT & LICENSE
-    Copyright 2009 Vincent Pit, all rights reserved.
+    Copyright 2009,2010,2011 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.