X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FUpgrading.pod;h=d1dd51900fb73f08787608751565ccf10db21555;hb=e37f92f5a9e3e83019ae0c2895439121bf533cde;hp=1955bfb642845dba22be309dd82fd48a74669ef9;hpb=e60068484721132e6fe1855f53f9542d8bb17a35;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod index 1955bfb..d1dd519 100644 --- a/lib/Catalyst/Upgrading.pod +++ b/lib/Catalyst/Upgrading.pod @@ -2,10 +2,20 @@ Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst +=head1 Upgrading to Catalyst 5.90040 + +This version of L offers some support for using L and +L event loops in your application. These changes should work +fine for most applications however if you are already trying to perform +some streaming, minor changes in this area of the code might affect your +functionality. + + TDB: more on streaming, transfer encoding chunked, etc. + =head1 Upgrading to Catalyst 5.9 The major change is that L, a toolkit for using the L -stack, now replaces most of the subclasses of L. If +specification, now replaces most of the subclasses of L. If you are using one of the standard subclasses of L this should be a straightforward upgrade for you. It was a design goal for this release to preserve as much backwards compatibility as possible. @@ -43,12 +53,16 @@ to use L. =head2 Upgrading the mod_perl / Apache Engines The engines that are built upon the various iterations of mod_perl, -L and L, -should be seamless upgrades and will work using using -L or L as required. +L (for mod_perl 1, and Apache 1.x) and +L (for mod_perl 2, and Apache 2.x), +should be seamless upgrades and will work using using L +or L as required. L, however, is no longer supported, as -Plack does not support mod_perl version 1.99 +Plack does not support mod_perl version 1.99. This is unlikely to be a +problem for anyone, as 1.99 was a brief beta-test release for mod_perl +2, and all users of mod_perl 1.99 are encouraged to upgrade to a +supported release of Apache 2 and mod_perl 2. =head2 Upgrading the HTTP Engine @@ -61,7 +75,7 @@ script is upgraded to use L. If you were using L there is no upgrade needed if your myapp_cgi.pl script is already upgraded to use L. -=head2 Upgrading the Preforking Engine +=head2 Upgrading Catalyst::Engine::HTTP::Prefork If you were using L then L is automatically loaded. You should (at least) change your C @@ -137,7 +151,6 @@ In the simplest case: becomes - MyCatalystApp->setup_engine('PSGI'); my $app = MyCatalystApp->psgi_app(@_); B: @@ -153,6 +166,10 @@ any tests run via L will not be compatible with the new release, and will result in the development server starting, rather than the expected test running. +B If you are directly accessing C<< $c->req->env >> to get the PSGI +environment then this accessor is moved to C<< $c->engine->env >>, +you will need to update your code. + =head2 Engines which are known to be broken The following engines B work as of Catalyst version 5.9. The @@ -190,10 +207,6 @@ Reports are highly encouraged: =back -=head2 Specifying the engine in the call to ->setup - -XXX FIXME - =head2 Plack functionality See L. @@ -211,6 +224,15 @@ This behavior has been removed, and now a 500 response will be returned to the test. This change standardizes behavior, so that local test requests behave similarly to remote requests. +=head2 Regex dispatch type is deprecated. + +The Regex dispatchtype (L) has been deprecated. + +You are encouraged to move your application to Chained dispatch (L). + +If you cannot do so, please add a dependency to Catalyst::DispatchType::Regex to your application's +Makefile.PL + =head1 Upgrading to Catalyst 5.80 Most applications and plugins should run unaltered on Catalyst 5.80. @@ -220,7 +242,7 @@ been made which could cause incompatibilities. If your application or plugin is using deprecated code, or relying on side effects, then you could have issues upgrading to this release. -Most issues found with pre-existing components have been easy to +Most issues found with existing components have been easy to solve. This document provides a complete description of behavior changes which may cause compatibility issues, and of new Catalyst warnings which might be unclear. @@ -278,7 +300,7 @@ replaces L with L, forcing all components to resolve methods using C3, rather than the unpredictable dispatch order of L. -This issue is characterised by your application failing to start due to an +This issue manifests itself by your application failing to start due to an error message about having a non-linear @ISA. The Catalyst plugin most often causing this is @@ -485,7 +507,7 @@ The following test demonstrates the problem: use Test::More; isnt(BaseClass->can('foo'), Child->can('foo')); -=head2 Extending Catalyst::Request or other classes in an ad-hoc manner using mk_accessors +=head2 Extending Catalyst::Request or other classes in an ad hoc manner using mk_accessors Previously, it was possible to add additional accessors to Catalyst::Request (or other classes) by calling the mk_accessors class method. @@ -512,6 +534,13 @@ The correct fix is to re-arrange your class's inheritance hierarchy so that the COMPONENT method you would like to inherit is the first (left-hand most) COMPONENT method in your @ISA. +=head2 Development server relying on environment variables + +Previously, the development server would allow propagation of system +environment variables into the request environment, this has changed with the +adoption of Plack. You can use L to achieve the +same effect. + =head1 WARNINGS =head2 Actions in your application class