X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2Findirect.git;a=blobdiff_plain;f=README;h=88f2bebc41249c95d5ea200d6b4feb6335888ac2;hp=efc7130ba9c2bf37cc91fa642f84fcc5852ff653;hb=9e1b933a7cdeed368a062f29cfe995d06416b714;hpb=bdaded2ebf07853d6c3270293769ff933b78fcff

diff --git a/README b/README
index efc7130..88f2beb 100644
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     indirect - Lexically warn about using the indirect object syntax.
 
 VERSION
-    Version 0.15
+    Version 0.17
 
 SYNOPSIS
         # In a script
@@ -16,6 +16,8 @@ SYNOPSIS
           my $z = new Pineapple 'fresh'; # croaks 'You really wanted Pineapple->new at blurp.pm:13'
          }
         }
+        try { ... }; # warns
+
         no indirect ':fatal';
         if (defied $foo) { ... } # croaks, note the typo
 
@@ -34,10 +36,9 @@ DESCRIPTION
     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").
-    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 for core functions ("print", "say", "exec" or
+    "system"). 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.
 
@@ -50,19 +51,35 @@ 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], the method name
-        as $_[1], the current file as $_[2] and the line number as $_[3].
+        called for each error with a string representation of the object as
+        $_[0], the method name as $_[1], the current file as $_[2] and the
+        line number as $_[3]. If and only if the object is actually a block,
+        $_[0] is assured to start by '{'.
 
     *   Otherwise, a warning will be emitted for each indirect construct.
 
   "import"
     Magically called at each "use indirect". Turns the module off.
 
+FUNCTIONS
+  "msg $object, $method, $file, $line"
+    Returns the default error message generated by "indirect" when an
+    invalid construct is reported.
+
 CONSTANTS
   "I_THREADSAFE"
     True iff the module could have been built with thread-safety features
     enabled.
 
+DIAGNOSTICS
+  "Indirect call of method "%s" on object "%s" at %s line %d."
+    The default warning/exception message thrown when an indirect call on an
+    object is found.
+
+  "Indirect call of method "%s" on a block at %s line %d."
+    The default warning/exception message thrown when an indirect call on a
+    block is found.
+
 CAVEATS
     The implementation was tweaked to work around several limitations of
     vanilla "perl" pragmas : it's thread safe, and doesn't suffer from a
@@ -77,6 +94,9 @@ CAVEATS
     is due to a shortcoming in the way perl handles the hints hash, which is
     addressed in perl 5.10.
 
+    The search for indirect method calls happens before constant folding.
+    Hence "my $x = new Class if 0" will be caught.
+
 DEPENDENCIES
     perl 5.8.
 
@@ -105,6 +125,9 @@ SUPPORT
 ACKNOWLEDGEMENTS
     Bram, for motivation and advices.
 
+    Andrew Main and Florian Ragwitz, for testing on real-life code and
+    reporting issues.
+
 COPYRIGHT & LICENSE
     Copyright 2008-2009 Vincent Pit, all rights reserved.