X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FUpgrading.pod;h=fbad34cbcd3db6ae86e5d72c046a4ad95c3b0776;hb=7ebac5f89810aab16ec76fc28dea45e936172a67;hp=07a1a673c5df06b1e425d80fb1c8e7476189a14d;hpb=3f22de0b6599bd10c0c50c0a33c3b359ffc1ea8d;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod index 07a1a67..fbad34c 100644 --- a/lib/Catalyst/Upgrading.pod +++ b/lib/Catalyst/Upgrading.pod @@ -2,18 +2,18 @@ Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst -=head1 Upgrading to Catalyst 5.90 +=head1 Upgrading to Catalyst 5.9 The major change is that L 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 be as backwardly compatible as possible. -However since L is different from L it would be -possible that edge case differences would exist. Therefore we recommend care -be taken with this upgrade and that testing should be greater than would be -the case with a minor point update. +However since L is different from L it is possible +that edge case differences exist. Therefore we recommend care be taken with +this upgrade and that testing should be greater than would be the case with a +minor point update. -It is highly recommended that you become familar with the L ecosystem +It is highly recommended that you become familiar with the L ecosystem and documentation. Being able to take advantage of L development and middleware is a major bonus to this upgrade. Documentation about how to take advantage of L by writing your own C<< .psgi >> file @@ -23,7 +23,7 @@ If you have created a custom subclass of L you will need to convert it to be a subclass of L. If you are using the L engine, L, this new -release supercedes that code. +release supersedes that code. If you are using a subclass of L that is aimed at nonstandard or internal / testing uses, such as L you should @@ -40,7 +40,7 @@ enough to use L. The engines that are build upon the various iterations of mod_perl, L and -L should be seemless upgrades and will +L should be seamless upgrades and will work using using L or L as required. @@ -63,13 +63,13 @@ myapp_cgi.pl script is already upgraded enough to use L. If you were using L then L is automatically loaded. -If you were customising your server script to pass opttions to the prefork engine, +If you were customising your server script to pass options to the prefork engine, then this is no longer supported. The recommended route to implement this functionality -is to write a simple .psgi file for your application, then use the L untility. +is to write a simple .psgi file for your application, then use the L utility. =head2 Upgrading the PSGI Engine -If you were using L this new release supercedes this +If you were using L this new release supersedes this engine in supporting L. By default the Engine is now always L. As a result, you can stop depending on L in your C. @@ -123,8 +123,8 @@ B: my $app = sub { MyCatalystApp->psgi_app(@_) }; # If you make ^^ this mistake, your app won't work, and will confuse the hell out of you! -You can now rename C<< script/myapp.psgi >> to C<< myapp.psgi >>, and the built-in -Catalyst scripts, and your test suite will start using your .psgi file. +You can now move C<< script/myapp.psgi >> to C<< myapp.psgi >> and the built-in +Catalyst scripts and your test suite will start using your .psgi file. B If you rename your .psgi file without these modifications, then any tests run via L will not be compatible with the new release, and will result in @@ -132,7 +132,7 @@ the development server starting, rather than the expected test running. =head2 Engines which are known broken -The following engines B work as of Catalyst version 5.90. The core +The following engines B work as of Catalyst version 5.9. The core team is extremely happy to work with the developers and/or users of these engines to help them port to the new Plack/Engine system, however applications which are currently using these engines B run without modification @@ -175,15 +175,15 @@ XXX FIXME See L. -=head2 Tests in 5.89 +=head2 Tests in 5.9 -Tests should generally work the same in Catalyst 5.89, however there are some differences. +Tests should generally work the same in Catalyst 5.9, however there are some differences. Previously, if using L and doing local requests (against a local server), if the application threw an exception then this exception propagated into the test. -This behaviour has been removed, and now a 500 response will be returned to the test. -This change unifies behaviour, to make local test requests behave similarly to remote +This behavior has been removed, and now a 500 response will be returned to the test. +This change unifies behavior, to make local test requests behave similarly to remote requests. =head1 Upgrading to Catalyst 5.80 @@ -198,7 +198,7 @@ issues upgrading to this release. Most issues found with pre-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 -be unclear. +might be unclear. If you think you have found an upgrade-related issue which is not covered in this document, please email the Catalyst list to discuss the problem. @@ -209,7 +209,7 @@ this document, please email the Catalyst list to discuss the problem. You can only apply method modifiers after the application's C<< ->setup >> method has been called. This means that modifiers will not work with methods -which run during the call to C<< ->setup >>. +run during the call to C<< ->setup >>. See L for more information about using L in your applications. @@ -556,7 +556,7 @@ is highly deprecated. The first time one of these methods is called, a warning will be emitted: Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name, - this will be removed in Catalyst 5.9X + this will be removed in Catalyst 5.9 You should B be calling any of these methods from application code.