[Catalyst-commits] r12001 - Catalyst-Devel/1.00/trunk/lib/Module/Install

[kasimon at dev.catalyst.perl.org]

Author: kasimon
Date: 2009-11-24 13:53:49 +0000 (Tue, 24 Nov 2009)
New Revision: 12001

Modified:
   Catalyst-Devel/1.00/trunk/lib/Module/Install/Catalyst.pm
Log:
Added POD description for some methods.
Added debian-specific files to ignore list.
Fixed subversion pattern in ignore list.


Modified: Catalyst-Devel/1.00/trunk/lib/Module/Install/Catalyst.pm
===================================================================
--- Catalyst-Devel/1.00/trunk/lib/Module/Install/Catalyst.pm	2009-11-24 09:50:07 UTC (rev 12000)
+++ Catalyst-Devel/1.00/trunk/lib/Module/Install/Catalyst.pm	2009-11-24 13:53:49 UTC (rev 12001)
@@ -15,7 +15,8 @@
 
 our @IGNORE =
   qw/Build Build.PL Changes MANIFEST META.yml Makefile.PL Makefile README
-  _build blib lib script t inc \.svn \.git _darcs \.bzr \.hg/;
+  _build blib lib script t inc .*\.svn \.git _darcs \.bzr \.hg
+  debian build-stamp install-stamp configure-stamp/;
 our @CLASSES   = ();
 our $ENGINE    = 'CGI';
 our $CORE      = 0;
@@ -25,12 +26,22 @@
 
 =head1 NAME
 
-Module::Install::Catalyst - Module::Install extension for Catalyst
-
+  Module::Install::Catalyst - Module::Install extension for Catalyst
+  
 =head1 SYNOPSIS
+  
+  use inc::Module::Install;
+  
+  name 'MyApp';
+  all_from 'lib/MyApp.pm';
+  
+  requires 'Catalyst::Runtime' => '5.7014';
+  
+  catalyst_ignore('.*temp');
+  catalyst_ignore('.*tmp');
+  catalyst;
+  WriteAll;
 
-See L<Catalyst>
-
 =head1 DESCRIPTION
 
 L<Module::Install> extension for Catalyst.
@@ -39,6 +50,9 @@
 
 =head2 catalyst
 
+Calls L<catalyst_files> and L<catalyst_par>. Should be the last catalyst*
+command called in C<Makefile.PL>.
+
 =cut
 
 sub catalyst {
@@ -55,6 +69,10 @@
 
 =head2 catalyst_files
 
+Collect a list of all files a Catalyst application consists of and copy it  
+inside the blib/lib/ directory. Files and directories that match the modules 
+ignore list are excluded (see L<catalyst_ignore> and L<catalyst_ignore_all>).
+
 =cut
 
 sub catalyst_files {
@@ -81,6 +99,8 @@
 
 =head2 catalyst_ignore_all(\@ignore)
 
+This function replaces the built-in default ignore list with the given list.
+
 =cut
 
 sub catalyst_ignore_all {
@@ -90,6 +110,8 @@
 
 =head2 catalyst_ignore(\@ignore)
 
+Add a regexp to the list of ignored patterns. Can be called multiple times.
+
 =cut
 
 sub catalyst_ignore {