[Catalyst-dev] Catalyst configuration pointer list

[Matt Hicks]

I recently posed some questions about Catalyst config on #catalyst.
t0m was very quick with doc updates to clarify what I'd done wrong.
Since he'd done that work, I went through all the general docs (but
not the tutorial) and made a list of what is explained where.


Catalyst  (in Catalyst::Runtime)
  runtime precedence, treating ConfigLoader as one step
  internal passing of config values to new objects
  how config values should be consumed
  config->{home} variable
  several other "base" config variables

Catalyst::Manual::ExtendingCatalyst
  how config should be consumed (recently updated)

Catalyst::Plugin::ConfigLoader
  has code that looks like how NOT to consume config, but is correct
when read with greater understanding :)

Catalyst::Plugin::ConfigLoader::Manual
  file precedence

Catalyst::Component
  internal passing of config values to new objects

Catalyst::Manual::Intro
  config->{root}


Catalyst.pm seems to contain the most details about how config works,
so I propose an add in the cookbook pointing there for details.


diff --git a/lib/Catalyst/Manual/Cookbook.pod b/lib/Catalyst/Manual/Cookbook.pod
index 7e8bcf9..afe8ce8 100644
@@ -215,6 +215,10 @@ This is equivalent to:
   # configure email sending
   __PACKAGE__->config( email => [qw/SMTP localhost/] );

+L<Catalyst> explains precedence of multiple sources for configuration
+values, how to access the values in your components, and many 'base'
+config variables used internally.
+
 See also L<Config::General|Config::General>.

 =head1 Skipping your VCS's directories