Don't actually create an entry when storing NULL in the ptable

[perl/modules/indirect.git] / README

diff --git a/README b/README
index 534bd7cea4b42780d5d61119988ee6eb08a8c153..18baca1937f77f7e2ae3bc8d39b1aada845f2bd4 100644 (file)
--- a/README
+++ b/README
@@ -2,18 +2,30 @@ NAME
     indirect - Lexically warn about using the indirect object syntax.
 
 VERSION
-    Version 0.07_01
+    Version 0.13
 
 SYNOPSIS
+        # In a script
         no indirect;
         my $x = new Apple 1, 2, 3; # warns
         {
          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 ':fatal';
         if (defied $foo) { ... } # croaks, note the typo
 
+        # From the command-line
+        perl -M-indirect -e 'my $x = new Banana;' # warns
+
+        # Or each time perl is ran
+        export PERL5OPT="-M-indirect"
+        perl -e 'my $y = new Coconut;' # warns
+
 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
@@ -30,16 +42,37 @@ DESCRIPTION
     This module is not a source filter.
 
 METHODS
-  "unimport @opts"
+  "unimport [ hook => $hook | ':fatal' ]"
     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.
+    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 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].
+
+    *   Otherwise, a warning will be emitted for each indirect construct.
 
   "import"
     Magically called at each "use indirect". Turns the module off.
 
+CONSTANTS
+  "I_THREADSAFE"
+    True iff the module could have been built when thread-safety features.
+
+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
-    perl 5.9.4.
+    perl 5.8.
 
     XSLoader (standard since perl 5.006).
 
@@ -67,7 +100,7 @@ ACKNOWLEDGEMENTS
     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.