From: Niko Tyni <ntyni@debian.org>
Date: Tue, 5 May 2009 06:07:57 +0000 (+0300)
Subject: Document that FileCache uses symbolic references
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=46f1a616f56f167d0a5af6a2d90cd809d2bd03d1;p=p5sagit%2Fp5-mst-13.2.git

Document that FileCache uses symbolic references

As noted by Marc Haber in <http://bugs.debian.org/318579>,
using FileCache.pm as per the SYNOPSIS doesn't work under
'use strict'. This is a bit unexpected nowadays, so mention
it in the documentation.
---

diff --git a/lib/FileCache.pm b/lib/FileCache.pm
index 285307f..5028291 100644
--- a/lib/FileCache.pm
+++ b/lib/FileCache.pm
@@ -8,6 +8,8 @@ FileCache - keep more files open than the system permits
 
 =head1 SYNOPSIS
 
+    no strict 'refs';
+
     use FileCache;
     # or
     use FileCache maxopen => 16;
@@ -71,6 +73,9 @@ FileCache does not store the current file offset if it finds it necessary to
 close a file.  When the file is reopened, the offset will be as specified by the
 original C<open> file mode.  This could be construed to be a bug.
 
+The module functionality relies on symbolic references, so things will break
+under 'use strict' unless 'no strict "refs"' is also specified.
+
 =head1 BUGS
 
 F<sys/param.h> lies with its C<NOFILE> define on some systems,