Make the op map thread safe

[perl/modules/indirect.git] / README

diff --git a/README b/README
index b273c8ad03d6a628b885911f2893b446bc8cd5c1..e1c879f449af30cb2a894e62e899d1ed867725db 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     indirect - Lexically warn about using the indirect object syntax.
 
 VERSION
     indirect - Lexically warn about using the indirect object syntax.
 
 VERSION

-    Version 0.04
+    Version 0.11

 
 SYNOPSIS
         no indirect;
 
 SYNOPSIS
         no indirect;


@@ -15,37 +15,47 @@ SYNOPSIS
         if (defied $foo) { ... } # croaks, note the typo
 
 DESCRIPTION
         if (defied $foo) { ... } # croaks, note the typo
 
 DESCRIPTION

-    When enabled (or disabled as some may prefer, since you actually turn it
-    on by calling "no indirect"), this pragma warns about indirect object
-    syntax constructs that may have slipped into your code. This syntax is
-    now considered harmful, since its parsing has many quirks and its use is
-    error prone (when "sub" isn't defined, "sub $x" is actually interpreted
-    as "$x->sub").
+    When enabled (or disabled as some may prefer to say, since you actually
+    turn it on by calling "no indirect"), this pragma warns about indirect
+    object syntax constructs that may have slipped into your code. This
+    syntax is now considered harmful, since its parsing has many quirks and
+    its use is error prone (when "sub" isn't defined, "sub $x" is actually
+    interpreted as "$x->sub").

 
     It currently does not warn when the object is enclosed between braces
     (like "meth { $obj } @args") or for core functions ("print" or "say").
     This may change in the future, or may be added as optional features that
     would be enabled by passing options to "unimport".
 
 
     It currently does not warn when the object is enclosed between braces
     (like "meth { $obj } @args") or for core functions ("print" or "say").
     This may change in the future, or may be added as optional features that
     would be enabled by passing options to "unimport".
 

+    This module is not a source filter.
+

 METHODS
   "unimport @opts"
 METHODS
   "unimport @opts"

-    Magically called when "no indirect @args" is encountered. Turns the
+    Magically called when "no indirect @opts" is encountered. Turns the

     module on. If @opts contains ':fatal', the module will croak on the
     first indirect syntax met.
 
   "import"
     Magically called at each "use indirect". Turns the module off.
 
     module on. If @opts contains ':fatal', the module will croak on the
     first indirect syntax met.
 
   "import"
     Magically called at each "use indirect". Turns the module off.
 

+CAVEATS
+    "meth $obj" (no semicolon) at the end of a file won't be seen as an
+    indirect object syntax, although it will as soon as there is another
+    token before the end (as in "meth $obj;" or "meth $obj 1").
+
+    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
 DEPENDENCIES

-    perl 5.9.4.
+    perl 5.8.

 
     XSLoader (standard since perl 5.006).
 
 AUTHOR
     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
 
 
     XSLoader (standard since perl 5.006).
 
 AUTHOR
     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
 

-    You can contact me by mail or on #perl @ FreeNode (vincent or
-    Prof_Vince).
+    You can contact me by mail or on "irc.perl.org" (vincent).

 
 BUGS
     Please report any bugs or feature requests to "bug-indirect at
 
 BUGS
     Please report any bugs or feature requests to "bug-indirect at


@@ -66,7 +76,7 @@ ACKNOWLEDGEMENTS
     Bram, for motivation and advices.
 
 COPYRIGHT & LICENSE
     Bram, for motivation and advices.
 
 COPYRIGHT & LICENSE

-    Copyright 2008 Vincent Pit, all rights reserved.
+    Copyright 2008-2009 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.