Only enable the pragma during compile time

[perl/modules/indirect.git] / README

diff --git a/README b/README
index c8d4438069cd48b8c935dbfb0066d55407211097..efc7130ba9c2bf37cc91fa642f84fcc5852ff653 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     indirect - Lexically warn about using the indirect object syntax.
 
 VERSION
-    Version 0.12
+    Version 0.15
 
 SYNOPSIS
         # In a script
@@ -12,8 +12,8 @@ SYNOPSIS
          use indirect;
          my $y = new Pear; # ok
          {
-          no indirect hook => sub { die "You really wanted $_[0]\->$_[1]" };
-          my $z = new Pineapple 'fresh'; # croaks 'You really wanted Pineapple->new'
+          no indirect hook => sub { die "You really wanted $_[0]\->$_[1] at $_[2]:$_[3]" };
+          my $z = new Pineapple 'fresh'; # croaks 'You really wanted Pineapple->new at blurp.pm:13'
          }
         }
         no indirect ':fatal';
@@ -31,8 +31,8 @@ DESCRIPTION
     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").
+    its use is error prone (when "swoosh" isn't defined, "swoosh $x"
+    actually compiles to "$x->swoosh").
 
     It currently does not warn when the object is enclosed between braces
     (like "meth { $obj } @args") or for core functions ("print" or "say").
@@ -50,8 +50,8 @@ METHODS
         indirect syntax met.
 
     *   If the key/value pair "hook => $hook" comes first, $hook will be
-        called for each error with the object name as $_[0] and the method
-        name as $_[1].
+        called for each error with the object name as $_[0], the method name
+        as $_[1], the current file as $_[2] and the line number as $_[3].
 
     *   Otherwise, a warning will be emitted for each indirect construct.
 
@@ -60,9 +60,15 @@ METHODS
 
 CONSTANTS
   "I_THREADSAFE"
-    True iff the module could have been built when thread-safety features.
+    True iff the module could have been built with thread-safety features
+    enabled.
 
 CAVEATS
+    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.
+
     "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").