From: Tomas Doran <bobtfish@bobtfish.net>
Date: Tue, 1 Feb 2011 21:50:48 +0000 (+0000)
Subject: Update changelog and upgrading
X-Git-Tag: 5.89001~8
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=93a57b4bb80efb5cee28d335a0a2e6a681ecd7d7

Update changelog and upgrading
---

diff --git a/Changes b/Changes
index a121d40..e6b1277 100644
--- a/Changes
+++ b/Changes
@@ -1,8 +1,19 @@
 # This file documents the revision history for Perl extension Catalyst.
 
- - Fixed Catalyst::Engine::Stomp
- - Fixed issues auto-loading engine with older scripts.
+ - Fixed Catalyst::Engine::Stomp compatibility. Applications using
+   Catalyst::Engine::Stomp are believed to continue working without
+   any changes with the new Catalyst major version.
 
+ - Fixed issues auto-loading engine with older scripts.
+ 
+ - Catalyst::Engine::Wx is officially unsupported and BROKEN. If you
+   are using this engine then please get in touch with us and we'll
+   be happy to help with the changes it needs to be compatible with
+   the new major version of Catalyst.
+
+ - XXX removal of engine_class?
+ - XXX removal of setup_engine($name)?
+   
 5.89000 2011-01-24 09:28:45 (TRIAL release)
 
  This is a development release from psgi branch of Catalyst-Runtime.
diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod
index 773e246..dc54861 100644
--- a/lib/Catalyst/Upgrading.pod
+++ b/lib/Catalyst/Upgrading.pod
@@ -72,8 +72,8 @@ C<Makefile.PL>.  Additionally, if you have an C<app.psgi> script you no longer
 need to specify the PSGI engine.  Instead, the L<Catalyst> application class
 now has a new method C<psgi_app> which returns a L<Plack> compatible coderef.
 
-For example, if you were using L<Catalyst::Engine::PSGI> in the past, you may
-have written an C<app.psgi> file similar to this one:
+For example, if you were using L<Catalyst::Engine::PSGI> in the past, you will
+have written (or generated) an C<app.psgi> file similar to this one:
 
     use Plack::Builder;
     use MyCatalytApp;
@@ -85,7 +85,7 @@ have written an C<app.psgi> file similar to this one:
         sub { MyCatalystApp->run(@_) };
     };
 
-Instead, you now just do
+Instead, you should now just do:
 
     use Plack::Builder;
     use MyCatalystApp;
@@ -95,6 +95,26 @@ Instead, you now just do
         MyCatalystApp->psgi_app;
     };
 
+Applications that were using and deploying via L<Catalyst::Engine::PSGI>
+previously should entirely continue to work in this release with no changes,
+however if you were using Catalyst::Engine::PSGI previously, then this is
+not compatible with L<Catalyst::Test> in the new version, and instead of
+running a test server
+
+=head2 Engines which are known broken
+
+The following engines B<DO NOT> work as of Catalyst version 5.90. 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<WILL NOT> run without modification
+to the engine code.
+
+=over
+
+=item Catalyst::Engine::Wx
+
+=back
+
 =head2 Engines with unknown status
 
 The following engines have untested or unknown compatibility.  Reports are
@@ -106,7 +126,6 @@ highly welcomed:
     Catalyst::Engine::Mojo
     Catalyst::Engine::Zeus - broken for ages
     Catalyst::Engine::JobQueue::POE - broken for ages
-    Catalyst::Engine::Wx
     Catalyst::Engine::Stomp - fixed
     Catalyst::Engine::Server (Marked as Deprecated)
     Catalyst::Engine::HTTP::POE (Marked as Deprecated)