Merge what I've done over the weekend
[catagits/Catalyst-Runtime.git] / lib / Catalyst / PSGI.pod
index bde2c0a..1aec1f8 100644 (file)
@@ -1,6 +1,10 @@
 =pod
 
-=head1 Catalyst and PSGI
+=head1 NAME
+
+Catalyst::PSGI - How Catalyst and PSGI work together
+
+=head1 SYNOPSIS
 
 Catalyst used to contain a whole set of C<< Catalyst::Engine::XXXX >> classes to
 adapt to various different web servers, and environments (e.g. CGI, FastCGI, mod_perl)
@@ -36,7 +40,7 @@ The simplest C<.psgi> file for an application called C<TestApp> would be:
 
 It should be noted that Catalyst may apply a number of middleware components for
 you automatically, and these B<will not> be applied if you manually create
-a psgi file yourself. Details of these middlewares can be found XXXX FIXME
+a psgi file yourself. Details of these middlewares can be found below.
 
 Additional information about psgi files can be found at:
 L<http://search.cpan.org/dist/Plack/lib/Plack.pm#.psgi_files>
@@ -56,11 +60,11 @@ engine specific fixes for uniform behaviour, as contained in:
 
 =over
 
-=item L<Plack::Middleware::LighttpdScriptNameFix> - FIXME, we don't use that really.
+=item L<Plack::Middleware::LighttpdScriptNameFix>
 
 =item L<Plack::Middleware::IIS6ScriptNameFix>
 
-=item nginx - FIXME??
+=item nginx - local to Catalyst
 
 =back
 
@@ -70,6 +74,10 @@ application returned when you call C<< MyApp->psgi_app >>, and if you need
 any of this functionality, you'll need to implement this in your C<< .psgi >>
 file yourself.
 
+An apply_default_middlewares method is supplied to wrap your application
+in the default middlewares if you want this behaviour and you are providing
+your own .psgi file.
+
 =head1 SEE ALSO
 
 L<Catalyst::Upgrading>, L<Plack>, L<PSGI::FAQ>, L<PSGI>.