[Catalyst-commits] r13901 - Catalyst-Runtime/5.80/branches/psgi/lib/Catalyst

[jnapiorkowski at dev.catalyst.perl.org]

Author: jnapiorkowski
Date: 2011-01-04 04:03:39 +0000 (Tue, 04 Jan 2011)
New Revision: 13901

Modified:
   Catalyst-Runtime/5.80/branches/psgi/lib/Catalyst/Upgrading.pod
Log:
first go at upgrading docs

Modified: Catalyst-Runtime/5.80/branches/psgi/lib/Catalyst/Upgrading.pod
===================================================================
--- Catalyst-Runtime/5.80/branches/psgi/lib/Catalyst/Upgrading.pod	2011-01-03 20:20:52 UTC (rev 13900)
+++ Catalyst-Runtime/5.80/branches/psgi/lib/Catalyst/Upgrading.pod	2011-01-04 04:03:39 UTC (rev 13901)
@@ -2,6 +2,103 @@
 
 Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst
 
+=head2 Upgrading to Catalyst 5.90
+
+The major change is that L<Plack> now replaces most of the subclasses of
+L<Catalyst::Engine>.  If you are using one of the standard subclasses of
+L<Catalyst::Engine> 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<Plack> is different from L<Catalyst::Engine> 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.
+
+It is highly recommended that you become familar with the L<Plack> ecosystem
+and documentation.  Being able to take advantage of L<Plack> development and
+middleware is a major bonus to this upgrade.
+
+If you have created a custom subclass of L<Catalyst:Engine> you will need to
+convert it to be a subclass of L<Plack::Handler>.
+
+If you are using the L<Plack> engine, L<Catalyst::Engine::PSGI>, this new
+release supercedes that code.
+
+If you are using a subclass of L<Catalyst::Engine> that is aimed at nonstandard
+or internal / testing uses, such as L<Catalyst::Engine::Embeddable> you should
+still be able to continue using that engine.
+
+Advice for specific subclasses of L<Catalyst::Engine> follows:
+
+=head2 Upgrading the FastCGI Engine
+
+    TBD
+
+=head2 Upgrading the mod_perl / Apache Engines
+
+The three engines that are build upon the various iterations of mod_perl,
+L<Catalyst::Engine::Apache2::MP19>, L<Catalyst::Engine::Apache::MP13> and
+L<Catalyst::Engine::Apache2::MP20> should be seemless upgrades and will
+work using using L<Plack::Handler::Apache1> or L<Plack::Handler::Apache2>
+as required.  
+
+=head2 Upgrading the HTTP Engine
+
+If you were using L<Catalyst::Engine::HTTP> (the default development server
+that comes with the L<Catalyst> distribution) you should now use...
+
+    TBD
+
+=head2 Upgrading the CGI Engine
+
+If you were using L<Catalyst::Engine::CGI> you should now use...
+
+    TBD
+
+=head2 Upgrading the Preforking Engine
+
+If you were using L<Catalyst::Engine::HTTP::Prefork> you should now use...
+
+    TBD
+
+=head2 Upgrading the Restarter Engines
+
+If you were using L<Catalyst::Engine::HTTP::Restarter> or 
+L<Catalyst::Engine::HTTP::Restarter::Watcher> these are now longer part of the
+L<Catalyst> distribution.  You should now use...
+
+    TBD
+
+=head2 Upgrading the PSGI Engine
+
+If you were using L<Catalyst::Engine::PSGI> this new release supercedes this
+engine in supporting L<Plack>.  You should now do...
+
+    TBD
+
+=head2 Engines with unknown status
+
+The following engines have untested or unknown compatibility.  Reports are
+highly welcomed:
+
+    Catalyst::Engine::Embeddable
+    Catalyst::Engine::XMPP2
+    Catalyst::Engine::SCGI
+    Catalyst::Engine::Mojo
+    Catalyst::Engine::Zeus
+    Catalyst::Engine::JobQueue::POE
+    Catalyst::Engine::Wx
+    Catalyst::Engine::Stomp
+    Catalyst::Engine::Server (Marked as Deprecated)
+    Catalyst::Engine::HTTP::POE (Marked as Deprecated)
+
+=head2 Engines known to not be compatible.
+
+If you are using one of the following L<Catalyst::Engine> subclasses, your
+application may require significant work after upgrading.  We recommend you
+test heavily and sandbox your upgrade.
+
+    TBD
+
 =head1 Upgrading to Catalyst 5.80
 
 Most applications and plugins should run unaltered on Catalyst 5.80.