c07766a234204d78a80b6d75534e03ae3465b6f3 is a better fix for RT #47902 than 4cb0e2cc2...

[perl/modules/indirect.git] / README

diff --git a/README b/README
index 88f2bebc41249c95d5ea200d6b4feb6335888ac2..d1b1229c0221abc04437cd1c09e0c1686ce43317 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.18
 
 SYNOPSIS
         # In a script
@@ -80,6 +80,18 @@ 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. 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