[Catalyst-commits] r6287 - in trunk/Catalyst-Runtime: . lib/Catalyst

[marcus at dev.catalyst.perl.org]

Author: marcus
Date: 2007-04-16 12:12:37 +0100 (Mon, 16 Apr 2007)
New Revision: 6287

Modified:
   trunk/Catalyst-Runtime/Changes
   trunk/Catalyst-Runtime/lib/Catalyst/Response.pm
Log:
Doc fix

Modified: trunk/Catalyst-Runtime/Changes
===================================================================
--- trunk/Catalyst-Runtime/Changes	2007-04-14 20:44:44 UTC (rev 6286)
+++ trunk/Catalyst-Runtime/Changes	2007-04-16 11:12:37 UTC (rev 6287)
@@ -1,6 +1,6 @@
 This file documents the revision history for Perl extension Catalyst.
 
-5.7008  XXXX-XX-XX
+5.7007  2007-03-13 14:18:00
         - Many performance improvements by not using URI.pm:
           * $c->uri_for (approx. 8x faster)
           * $c->engine->prepare_path (approx. 27x faster)
@@ -11,8 +11,6 @@
           * Uploaded files with the name "0" are no longer ignored.
         - Sending SIGHUP to the dev server will now cause it to restart.
         - Allow "0" for a path in uri_for.
-
-5.7007  2007-03-13 14:18:00
         - Performance and stability improvements to the built-in HTTP server.
         - Don't ignore file uploads if form contains a text field with the same name.
           (Carl Franks)

Modified: trunk/Catalyst-Runtime/lib/Catalyst/Response.pm
===================================================================
--- trunk/Catalyst-Runtime/lib/Catalyst/Response.pm	2007-04-14 20:44:44 UTC (rev 6286)
+++ trunk/Catalyst-Runtime/lib/Catalyst/Response.pm	2007-04-16 11:12:37 UTC (rev 6287)
@@ -34,15 +34,19 @@
 =head1 DESCRIPTION
 
 This is the Catalyst Response class, which provides methods for responding to
-the current client request.
+the current client request. The appropriate L<Catalyst::Engine> for your environment
+will turn the Catalyst::Response into a HTTP Response and return it to the client.
 
 =head1 METHODS
 
-=head2 $res->body($text)
+=head2 $res->body(<$text|$fh|$iofh_object)
 
     $c->response->body('Catalyst rocks!');
 
-Sets or returns the output (text or binary data).
+Sets or returns the output (text or binary data). If you are returning a large body,
+you might want to use a L<IO::FileHandle> type of object (Something that implements the read method
+in the same fashion), or a filehandle GLOB. Catalyst
+will write it piece by piece into the response.
 
 =head2 $res->content_encoding