Add a link to Matt's blog post

[perl/modules/indirect.git] / README

diff --git a/README b/README
index 88f2bebc41249c95d5ea200d6b4feb6335888ac2..a254d34e5faf457aba026e38de3c7627ef58446a 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     indirect - Lexically warn about using the indirect object syntax.
 
 VERSION
-    Version 0.17
+    Version 0.19
 
 SYNOPSIS
         # In a script
@@ -71,6 +71,11 @@ CONSTANTS
     True iff the module could have been built with thread-safety features
     enabled.
 
+  "I_FORKSAFE"
+    True iff this module could have been built with fork-safety features
+    enabled. This will always be true except on Windows where it's false for
+    perl 5.10.0 and below .
+
 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
@@ -80,6 +85,19 @@ DIAGNOSTICS
     The default warning/exception message thrown when an indirect call on a
     block is found.
 
+ENVIRONMENT
+  "PERL_INDIRECT_PM_DISABLE"
+    If this environment variable is set to true when the pragma is used for
+    the first time, the XS code won't be loaded and, although the 'indirect'
+    lexical hint will be set to true in the scope of use, the pragma itself
+    won't do anything. In this case, the pragma will always be considered to
+    be thread-safe, and as such "I_THREADSAFE" will be true. This is useful
+    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
+    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