X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2Findirect.git;a=blobdiff_plain;f=README;h=64b28925d24edcd7ca4da403e019f44c9618e5e7;hp=a254d34e5faf457aba026e38de3c7627ef58446a;hb=497e022617b74ddc8be597bcace36eeed9ac18f7;hpb=8a6edfe3e713d47f83fcee92125f992769c67884 diff --git a/README b/README index a254d34..64b2892 100644 --- a/README +++ b/README @@ -2,7 +2,7 @@ NAME indirect - Lexically warn about using the indirect object syntax. VERSION - Version 0.19 + Version 0.22 SYNOPSIS # In a script @@ -18,7 +18,7 @@ SYNOPSIS } try { ... }; # warns - no indirect ':fatal'; + no indirect ':fatal'; # or 'FATAL', or ':Fatal' ... 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 - 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 + , + 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 @@ -43,12 +47,12 @@ DESCRIPTION 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 : - * 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 @@ -95,12 +99,12 @@ ENVIRONMENT 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 - 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. @@ -116,7 +120,7 @@ CAVEATS Hence "my $x = new Class if 0" will be caught. DEPENDENCIES - perl 5.8. + perl 5.8.1. XSLoader (standard since perl 5.006). @@ -147,7 +151,7 @@ ACKNOWLEDGEMENTS 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.