Re-arrange, reformatting, add a coupla bits, remove a couple of non-relevant bits
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Delta.pod
index 2c94406..582c032 100755 (executable)
@@ -1,82 +1,99 @@
 =head1 Deltachanges from 5.7 to 5.8
 
-
 This is an overview of the user visible changes in 5.8
 
 =head2 Deprecations
 
-::[MVC]:: style naming scheme has been deprecated and will warn
+Please see L<Catalyst::Upgrading> for a full description of how changes in the
+framework may affect your application.
+
+Below is a brief list of features which have been deprecated in this release:
+
+=over
 
+=item ::[MVC]:: style naming scheme has been deprecated and will warn
 
- - Use Class::C3::Adopt::NEXT (rafl)
+=item NEXT is deprecated for all applications and components, use MRO::Compat
 
-Catalyst 5.80 uses L<Algorithm::C3> method dispatch order. This is built into
-perl 5.10 (new pragma mro), and comes via L<Class::C3> for perl 5.8. This
-replaces L<NEXT> with L<Class::C3::Adopt::NEXT>, forcing all components to
-resolve methods using C3, rather than the unpredictable dispatch order of
-L<NEXT>. Please "use MRO::Compat" in both perl 5.8 and perl 5.10 to activate
-this feature.
-- Disallow writing to config after setup and disallow calling setup more 
-than once (rafl)
+=item Dispatcher methods which are an implementation detail made private, public versions now warn.
 
-=head2 Dispatcher
+=item MyApp->plugin method is deprecated, use L<Catalyst::Model::Adaptor> instead.
 
-- visit and go now takes CaptureArgs
+=item __PACKAGE__->mk_accessors() is supported for backward compatibility only, use Moose attributes instead in new code.
 
-        - Change the $c->visit and $c->go methods to optionally take
-          CaptureArgs, making them useful to call ActionChains with (t0m)
+=back
 
-        - Fix forwarding to Catalyst::Action objects (Rafael Kitover).
+=head2 New features
 
-=head2 restarter
+=head3 Dispatcher
 
-- Non-naive implementation of making mutable on restart using
-  B::Hooks::OP::Check::StashChange if installed (t0m)
-  For a restart the immutable Moose-objects need to turn back to mutable.
-  With L<B::Hooks::OP::Check::StashChange> installed this will be done.
+Fix forwarding to Catalyst::Action objects (Rafael Kitover).
 
-= head2 $c->uri_for_action method. (hdp)
+=head3 Restarter
+
+The development server restarter has been improved to be compatible with
+immutable Moose classes, and also to optionally use 
+L<B::Hooks::OP::Check::StashChange> to handle more complex application layouts
+correctly.
+
+=head3 $c->uri_for_action method. (hdp)
 
 A private path to the Catalyst action you want to create a URI for.
 This is a shortcut for calling C<< $c->dispatcher->get_action_by_path($path) >>
 and passing the resulting C<$action> and the remaining arguments to 
 C<< $c->uri_for >>.
 
+=head3 Logging
 
-=head2 Logging
+Log levels have been madeadditive, and add documentation to the setup_log 
+method.
 
-        - Make log levels additive, and add documentation and tests
-          for the setup_log method, which previously had none.
-          Sewn together by t0m from two patches provided by David E. Wheeler
+=head3 L<Catalyst::Test>
 
-=head2 Consequences of the Moose backend
+=over
 
-        - Use MooseX::MethodAttributes::Inheritable to contain action
-          attributes. This means that attributes are now represented in the MOP,
-          allowing method modifiers on actions to work as expected. (rafl)
-        - Provide a reasonable API in Catalyst::Controller for working with
-          and registering actions, allowing a controller sub-class to replace
-          subroutine attributes for action declerations with an alternate
-          syntax. (rafl/hdp)
-        - Refactor capturing of $app from Catalyst::Controller into
-          Catalyst::Component::ApplicationAttribute for easier reuse in other
-          components (Florian Ragwitz)
-        - Make MyApp immutable at the end of the scope after the setup
-          method is called, fixing issues with plugins which have their 
-          own new methods by inlining a constructor on MyApp (t0m)        
-        - Instantiate correct sub-class of Moose::Meta::Class for non-Moose
-          components where Catalyst forces the creation of a metaclass instance.
-=head2 Test Suite
-
-        - Change Catalyst::Test to use Sub::Exporter (Florian Ragwitz).
-        - Port to Moose
-        - Support mocking virtualhosts in test suite ()
-        - Add methods like action_ok and action_redirect to write
-          more compact tests
-
-=head2 Catalyst::Response->print()
+=item Change to use L<Sub::Exporter>.
+
+=item Port to L<Moose>.
+
+=item Support mocking multiple virtual hosts
+
+=item New methods like action_ok and action_redirect to write more compact tests
+
+=back
+
+=head3 $c->response->print()
 
 Prints @data to the output stream, separated by $,.  This lets you pass
 the response object to functions that want to write to an L<IO::Handle>.
 
+=head2 Consequences of the Moose backend
+
+=over
+
+=item *
+
+L<MooseX::MethodAttributes::Inheritable> used to contain action
+attributes. This means that attributes are now represented in the MOP,
+allowing method modifiers on actions to work as expected.
+
+=item *
+
+There is a reasonable API in Catalyst::Controller for working with
+and registering actions, allowing a controller sub-class to replace
+subroutine attributes for action declerations with an alternate
+syntax.
+
+=item *
+
+Refactored capturing of $app from L<Catalyst::Controller> into
+L<Catalyst::Component::ApplicationAttribute> for easier reuse in other
+components
+
+=item *
+
+Your application is forced to become immutable after the setup
+method is called.
+
+=back
+