Update VPIT::TestHelpers to 15e8aee3

[perl/modules/indirect.git] / README

diff --git a/README b/README
index f332f4a3f40185dcf03a234e65c9d096c6701711..fa7c71bfd5c00cd4f18271b6d97c8c1d53c23250 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     indirect - Lexically warn about using the indirect method call syntax.
 
 VERSION
     indirect - Lexically warn about using the indirect method call syntax.
 
 VERSION

-    Version 0.32
+    Version 0.37

 
 SYNOPSIS
     In a script :
 
 SYNOPSIS
     In a script :


@@ -41,10 +41,9 @@ DESCRIPTION
     The indirect syntax is now considered harmful, since its parsing has
     many quirks and its use is error prone : when the subroutine "foo" has
     not been declared in the current package, "foo $x" actually compiles to
     The indirect syntax is now considered harmful, since its parsing has
     many quirks and its use is error prone : when the subroutine "foo" has
     not been declared in the current package, "foo $x" actually compiles to

-    "$x->foo", and "foo { key => 1 }" to "'key'->foo(1)". In
-    <http://www.shadowcat.co.uk/blog/matt-s-trout/indirect-but-still-fatal>,
-    Matt S. Trout gives an example of an undesirable indirect method call on
-    a block that can cause a particularly bewildering error.
+    "$x->foo", and "foo { key => 1 }" to "'key'->foo(1)". Please refer to
+    the "REFERENCES" section for a more complete list of reasons for
+    avoiding this construct.

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


@@ -173,6 +172,24 @@ CAVEATS
     The search for indirect method calls happens before constant folding.
     Hence "my $x = new Class if 0" will be caught.
 
     The search for indirect method calls happens before constant folding.
     Hence "my $x = new Class if 0" will be caught.
 

+REFERENCES
+    Numerous articles have been written about the quirks of the indirect
+    object construct :
+
+    *   <http://markmail.org/message/o7d5sxnydya7bwvv> : Far More Than
+        Everything You've Ever Wanted to Know about the Indirect Object
+        syntax, Tom Christiansen, 1998-01-28.
+
+        This historical post to the "perl5-porters" mailing list raised
+        awareness about the perils of this syntax.
+
+    *   <http://www.shadowcat.co.uk/blog/matt-s-trout/indirect-but-still-fat
+        al> : Indirect but still fatal, Matt S. Trout, 2009-07-29.
+
+        In this blog post, the author gives an example of an undesirable
+        indirect method call on a block that causes a particularly
+        bewildering error.
+

 DEPENDENCIES
     perl 5.8.1.
 
 DEPENDENCIES
     perl 5.8.1.
 


@@ -198,9 +215,6 @@ SUPPORT
 
         perldoc indirect
 
 
         perldoc indirect
 

-    Tests code coverage report is available at
-    <http://www.profvince.com/perl/cover/indirect>.
-

 ACKNOWLEDGEMENTS
     Bram, for motivation and advices.
 
 ACKNOWLEDGEMENTS
     Bram, for motivation and advices.
 


@@ -208,8 +222,8 @@ ACKNOWLEDGEMENTS
     reporting issues.
 
 COPYRIGHT & LICENSE
     reporting issues.
 
 COPYRIGHT & LICENSE

-    Copyright 2008,2009,2010,2011,2012,2013,2014 Vincent Pit, all rights
-    reserved.
+    Copyright 2008,2009,2010,2011,2012,2013,2014,2015,2016 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.