Abstract the MGWIZ creation into a new vmg_mgwiz_alloc() function

[perl/modules/Variable-Magic.git] / README

diff --git a/README b/README
index 98026bb4bc4e64d5d0c287d997d9bb8be06564a2..ac81e42c52bcf6d095d254e9dcbd72d4238ba4e6 100644 (file)
--- a/README
+++ b/README
@@ -2,10 +2,10 @@ NAME
     Variable::Magic - Associate user-defined magic to variables from Perl.
 
 VERSION
-    Version 0.44
+    Version 0.46
 
 SYNOPSIS
-        use Variable::Magic qw/wizard cast VMG_OP_INFO_NAME/;
+        use Variable::Magic qw<wizard cast VMG_OP_INFO_NAME>;
 
         { # A variable tracer
          my $wiz = wizard set  => sub { print "now set to ${$_[0]}!\n" },
@@ -307,7 +307,8 @@ CONSTANTS
 
   "VMG_UVAR"
     When this constant is true, you can use the "fetch,store,exists,delete"
-    callbacks on hashes.
+    callbacks on hashes. Initial VMG_UVAR capability was introduced in perl
+    5.9.5, with a fully functional implementation shipped with perl 5.10.0.
 
   "VMG_COMPAT_ARRAY_PUSH_NOLEN"
     True for perls that don't call 'len' magic when you push an element in a
@@ -362,7 +363,7 @@ COOKBOOK
         {
          package Magical::UserData;
 
-         use Variable::Magic qw/wizard cast getdata/;
+         use Variable::Magic qw<wizard cast getdata>;
 
          my $wiz = wizard data => sub { \$_[1] };
 
@@ -495,9 +496,15 @@ CAVEATS
     this destructor won't be called because the wizard will be destroyed
     first.
 
+    In order to define magic on hash members, you need at least perl 5.10.0
+    (see "VMG_UVAR")
+
 DEPENDENCIES
     perl 5.8.
 
+    A C compiler. This module may happen to build with a C++ compiler as
+    well, but don't rely on it, as no guarantee is made in this regard.
+
     Carp (standard since perl 5), XSLoader (standard since perl 5.006).
 
     Copy tests need Tie::Array (standard since perl 5.005) and Tie::Hash
@@ -536,7 +543,7 @@ SUPPORT
     <http://www.profvince.com/perl/cover/Variable-Magic>.
 
 COPYRIGHT & LICENSE
-    Copyright 2007,2008,2009,2010 Vincent Pit, all rights reserved.
+    Copyright 2007,2008,2009,2010,2011 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.