[Catalyst-commits] r9650 - trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin

[t0m at dev.catalyst.perl.org]

Author: t0m
Date: 2009-04-03 02:08:14 +0100 (Fri, 03 Apr 2009)
New Revision: 9650

Modified:
   trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication.pm
Log:
Tidy up notes about realms key in configuration, all the clues came from jayk++

Modified: trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication.pm
===================================================================
--- trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication.pm	2009-04-03 00:22:50 UTC (rev 9649)
+++ trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication.pm	2009-04-03 01:08:14 UTC (rev 9650)
@@ -799,7 +799,8 @@
                 };
 
 NOTE: Until version 0.10008 of this module, you would need to put all the
-realms inside a "realms" key in the configuration. That is not required anymore.
+realms inside a "realms" key in the configuration. Please see 
+L</COMPATIBILITY CONFIGURATION> for more information
 
 =over 4
 
@@ -1011,6 +1012,25 @@
 covered in L<Catalyst::Plugin::Authentication::Internals>.  We hope that most
 modules will move to the compatible list above very quickly.
 
+=head1 COMPATIBILITY CONFIGURATION
+
+Until version 0.10008 of this module, you needed to put all the
+realms inside a "realms" key in the configuration. 
+
+    # example
+    __PACKAGE__->config->{'Plugin::Authentication'} = 
+                {  
+                    default_realm => 'members',
+                    realms => {
+                        members => {
+                            ...
+                        },
+                    },
+                };
+
+If you use the old, deprecated C<< __PACKAGE__->config->{'authentication'} >>
+configuration key, then the realms key is still required.
+
 =head1 COMPATIBILITY ROUTINES
 
 In version 0.10 of L<Catalyst::Plugin::Authentication>, the API