Clarify the component back compat section, and add info about 5.71001

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Upgrading.pod

diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod
index ae5a6ff..65b1d61 100644 (file)
--- a/lib/Catalyst/Upgrading.pod
+++ b/lib/Catalyst/Upgrading.pod
@@ -16,6 +16,36 @@ this document, then please email the Catalyst list to discuss the problem.
 
 =head1 Known backwards compatibility breakages.
 
+=head2 Issues with Class::C3
+
+Catalyst 5.80 uses L<Algorithm::C3> method dispatch order. This is built into
+perl 5.10, 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>.
+
+To be able to do this, however, entails that the graph of superclasses for each
+class must be linearizable using the C3 algorithm. Unfortunately, when
+superclasses are being used as mixins, it is easy to get this wrong.
+
+Most common is the case of:
+
+    package Component1; # Note, this is the common case
+    use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
+
+    package Component2; # Accidentally saying it this way round causes fail.
+    use base qw/Class::Data::Inheritable Class::Accessor::Fast/;
+
+    package GoesBang;
+    use base qw/Component1 Component2/;
+
+And the Catalyst plugin most often causing this, is
+L<Catalyst::Plugin::Sesssion::Store::FastMMap> - if you are using this plugin
+and see issues, then please upgrade!
+
+This can, however, be found in your own application - the only solution is to
+go through each base class of the class the error was reported against, until
+you identify the ones in conflict, and resolve them.
+
 =head2 Components which inherit from Moose::Object before Catalyst::Component
 
 Moose components which say:
@@ -52,10 +82,18 @@ compatible way is:
     BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever
 
 Note that the C< extends > declaration needs to occur in a begin block for
-L<attributes> to operate correctly. You also don't get the L<Moose::Object>
-constructor, and therefore attribute initialization will not work as normally
-expected. If you want to use Moose attributes, then they need to be made lazy
-to correctly initialize.
+L<attributes> to operate correctly.
+
+You also don't get the L<Moose::Object> constructor, and therefore attribute 
+initialization will not work as normally expected. If you want to use Moose 
+attributes, then they need to be made lazy to correctly initialize.
+
+Note that this only applies if your component needs to maintain component
+backwards compatibility for Catalyst versions before 5.71001 - in 5.71001
+attributes work as expected, and the BUILD method is called normally
+(although BUILDARGS is not). 
+
+If you depend on Catalyst 5.8, then B<all> Moose features work as expected.
 
 =head3 use Moose in MyApp