From: Tony Cook <tony@develop-help.com>
Date: Wed, 25 Jun 2014 11:26:54 +0000 (+1000)
Subject: actually document the change in read buffer values
X-Git-Tag: v0.99~2
X-Git-Url: http://git.imager.perl.org/imager.git/commitdiff_plain/83e58721c3dc7cae5baaad465d3ac6a088d6a13c?ds=inline

actually document the change in read buffer values
---

diff --git a/lib/Imager/Files.pod b/lib/Imager/Files.pod
index 5dc8aa10..243fe752 100644
--- a/lib/Imager/Files.pod
+++ b/lib/Imager/Files.pod
@@ -237,10 +237,8 @@ the image.
 =item *
 
 C<data> - When reading data, C<data> is a scalar containing the image
-file data, when writing, C<data> is a reference to the scalar to save
-the image file data too.  For GIF images you will need C<giflib> 4 or
-higher, and you may need to patch C<giflib> to use this option for
-writing.
+file data, or a reference to such a scalar.  When writing, C<data> is
+a reference to the scalar to save the image file data to.
 
   my $data;
   $image->write(data => \$data, type => 'tiff')
@@ -250,6 +248,10 @@ writing.
   my @images = Imager->read_multi(data => $data)
     or die Imager->errstr;
 
+  # from Imager 0.99
+  my @images = Imager->read_multi(data => \$data)
+    or die Imager->errstr;
+
 =item *
 
 C<callback>, C<readcb>, C<writecb>, C<seekcb>, C<closecb> - Imager
diff --git a/lib/Imager/IO.pod b/lib/Imager/IO.pod
index 988042b5..eee08423 100644
--- a/lib/Imager/IO.pod
+++ b/lib/Imager/IO.pod
@@ -39,11 +39,12 @@ Create a new I/O layer based on a file descriptor.
 
 Create a new I/O layer based on a memory buffer.
 
-The supplied variable must not be changed during the life of the I/O
-object.
-
 Buffer I/O layers are read only.
 
+C<$data> can either a simple octet string, or a reference to an octet
+string.  If C<$data> contains characters with a code point above 0xFF
+an exception will be thrown.
+
 =item new_cb($writecb, $readcb, $seekcb, $closecb)
 
 Create a new I/O layer based on callbacks.  See