Test interaction with eval STRING

[perl/modules/indirect.git] / README

diff --git a/README b/README
index a254d34e5faf457aba026e38de3c7627ef58446a..e1aa30551a21b8d57b5b484bfd0709930de61adc 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.19
+    Version 0.23

 
 SYNOPSIS
         # In a script
 
 SYNOPSIS
         # In a script


@@ -18,7 +18,7 @@ SYNOPSIS
         }
         try { ... }; # warns
 
         }
         try { ... }; # warns
 

-        no indirect ':fatal';
+        no indirect ':fatal';    # or 'FATAL', or ':Fatal' ...

         if (defied $foo) { ... } # croaks, note the typo
 
         # From the command-line
         if (defied $foo) { ... } # croaks, note the typo
 
         # From the command-line


@@ -31,10 +31,14 @@ SYNOPSIS
 DESCRIPTION
     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
 DESCRIPTION
     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 "swoosh" isn't defined, "swoosh $x"
-    actually compiles to "$x->swoosh").
+    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 "swoosh" is not defined, "swoosh $x"
+    actually compiles to "$x->swoosh"). In
+    <http://www.shadowcat.co.uk/blog/matt-s-trout/indirect-but-still-fatal>,
+    Matt S. Trout gives an example of an indirect construct that can cause a
+    particularly bewildering error.

 
     It currently does not warn for core functions ("print", "say", "exec" or
     "system"). This may change in the future, or may be added as optional
 
     It currently does not warn for core functions ("print", "say", "exec" or
     "system"). This may change in the future, or may be added as optional


@@ -43,12 +47,12 @@ DESCRIPTION
     This module is not a source filter.
 
 METHODS
     This module is not a source filter.
 
 METHODS

-  "unimport [ hook => $hook | ':fatal' ]"
+  "unimport [ hook => $hook | ':fatal', 'FATAL', ... ]"

     Magically called when "no indirect @opts" is encountered. Turns the
     module on. The policy to apply depends on what is first found in @opts :
 
     Magically called when "no indirect @opts" is encountered. Turns the
     module on. The policy to apply depends on what is first found in @opts :
 

-    *   If it's the string ':fatal', the compilation will croak on the first
-        indirect syntax met.
+    *   If it is a string that matches "/^:?fatal$/i", the compilation will
+        croak on the first indirect syntax met.

 
     *   If the key/value pair "hook => $hook" comes first, $hook will be
         called for each error with a string representation of the object as
 
     *   If the key/value pair "hook => $hook" comes first, $hook will be
         called for each error with a string representation of the object as


@@ -95,18 +99,20 @@ ENVIRONMENT
     for disabling "indirect" in production environments.
 
     Note that clearing this variable after "indirect" was loaded has no
     for disabling "indirect" in production environments.
 
     Note that clearing this variable after "indirect" was loaded has no

-    effect. If you want to reenable the pragma later, you also need to
+    effect. If you want to re-enable the pragma later, you also need to

     reload it by deleting the 'indirect.pm' entry from %INC.
 
 CAVEATS
     The implementation was tweaked to work around several limitations of
     reload it by deleting the 'indirect.pm' entry from %INC.
 
 CAVEATS
     The implementation was tweaked to work around several limitations of

-    vanilla "perl" pragmas : it's thread safe, and doesn't suffer from a
+    vanilla "perl" pragmas : it's thread safe, and does not suffer from a

     "perl 5.8.x-5.10.0" bug that causes all pragmas to propagate into
     "require"d scopes.
 
     "perl 5.8.x-5.10.0" bug that causes all pragmas to propagate into
     "require"d scopes.
 

-    "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").
+    Before "perl" 5.12, "meth $obj" (no semicolon) at the end of a file is
+    not seen as an indirect object syntax, although it is as soon as there
+    is another token before the end (as in "meth $obj;" or "meth $obj 1").
+    If you use "perl" 5.12 or greater, those constructs are correctly
+    reported.

 
     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
 
     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


@@ -116,7 +122,7 @@ CAVEATS
     Hence "my $x = new Class if 0" will be caught.
 
 DEPENDENCIES
     Hence "my $x = new Class if 0" will be caught.
 
 DEPENDENCIES

-    perl 5.8.
+    perl 5.8.1.

 
     XSLoader (standard since perl 5.006).
 
 
     XSLoader (standard since perl 5.006).
 


@@ -147,7 +153,7 @@ ACKNOWLEDGEMENTS
     reporting issues.
 
 COPYRIGHT & LICENSE
     reporting issues.
 
 COPYRIGHT & LICENSE

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