Examples and documentation update and cleanup

[dbsrgits/DBIx-Class.git] / maint / Makefile.PL.inc / 53_autogen_pod.pl

diff --git a/maint/Makefile.PL.inc/53_autogen_pod.pl b/maint/Makefile.PL.inc/53_autogen_pod.pl
index 2496a47..ff72fd9 100644 (file)
--- a/maint/Makefile.PL.inc/53_autogen_pod.pl
+++ b/maint/Makefile.PL.inc/53_autogen_pod.pl
@@ -21,6 +21,9 @@ else {
 # generate the OptDeps pod both in the clone-dir and during the makefile distdir
 {
   print "Regenerating Optional/Dependencies.pod\n";
+
+  # this should always succeed - hence no error checking
+  # if someone breaks OptDeps - travis should catch it
   require DBIx::Class::Optional::Dependencies;
   DBIx::Class::Optional::Dependencies->_gen_pod ($ver, "$pod_dir/lib");
 
@@ -50,8 +53,20 @@ EOP
   my $pod_fn = "$pod_dir/dbicadmin.pod";
 
   # if the author doesn't have the prereqs, don't fail the initial "perl Makefile.pl" step
-  # therefore no error checking
-  system($^X, qw( -Ilib -- script/dbicadmin --documentation-as-pod ), $pod_fn);
+  my $great_success;
+  {
+    local @ARGV = ('--documentation-as-pod', $pod_fn);
+    local $0 = 'dbicadmin';
+    local *CORE::GLOBAL::exit = sub { $great_success++; die; };
+    do 'script/dbicadmin';
+  }
+  if (!$great_success and ($@ || $!) ) {
+    printf ("FAILED!!! Subsequent `make dist` will fail. %s\n",
+      $ENV{DBICDIST_DEBUG}
+        ? 'Full error: ' . ($@ || $!)
+        : 'Re-run with $ENV{DBICDIST_DEBUG} set for more info'
+    );
+  }
 
   postamble <<"EOP";
 
@@ -64,13 +79,9 @@ EOP
 }
 
 
-# generate the inherit pods both in the clone-dir and during the makefile distdir
+# generate the inherit pods only during distbuilding phase
+# it is too slow to do at regular Makefile.PL
 {
-  print "Regenerating project documentation to include inherited methods\n";
-
-  # if the author doesn't have the prereqs, don't fail the initial "perl Makefile.pl" step
-  do "maint/gen_pod_inherit" or print "\n!!! FAILED: $@\n";
-
   postamble <<"EOP";
 
 clonedir_generate_files : dbic_clonedir_gen_inherit_pods
@@ -82,6 +93,32 @@ EOP
 }
 
 
+# generate the DBIx/Class.pod only during distdir
+{
+  my $dist_pod_fn = File::Spec->catfile($pod_dir, qw(lib DBIx Class.pod));
+
+  postamble <<"EOP";
+
+clonedir_generate_files : dbic_distdir_gen_dbic_pod
+
+dbic_distdir_gen_dbic_pod :
+
+\tperldoc -u lib/DBIx/Class.pm > $dist_pod_fn
+\t@{[ $mm_proto->oneliner(
+  "s!^.*?this line is replaced with the author list.*! qq{List of the awesome contributors who made DBIC v$ver possible\n\n} . qx(\$^X -Ilib maint/gen_pod_authors)!me",
+  [qw( -0777 -p -i )]
+) ]} $dist_pod_fn
+
+create_distdir : dbic_distdir_defang_authors
+
+# Remove the maintainer-only warning (be nice ;)
+dbic_distdir_defang_authors :
+\t@{[ $mm_proto->oneliner('s/ ^ \s* \# \s* \*\*\* .+ \n ( ^ \s* \# \s*? \n )? //xmg', [qw( -0777 -p -i )] ) ]} \$(DISTVNAME)/AUTHORS
+
+EOP
+}
+
+
 # on some OSes generated files may have an incorrect \n - fix it
 # so that the xt tests pass on a fresh checkout (also shipping a
 # dist with CRLFs is beyond obnoxious)
@@ -123,9 +160,8 @@ EOP
 clonedir_cleanup_generated_files : dbic_clonedir_cleanup_generated_pod_copies
 
 dbic_clonedir_cleanup_generated_pod_copies :
-\t@{[
-  $mm_proto->oneliner("uninstall(q($pod_dir.packlist))", ['-MExtUtils::Install'])
-]}
+\t@{[ $mm_proto->oneliner('chomp && unlink || die', ['-n']) ]} $pod_dir.packlist
+\t\$(RM_F) $pod_dir.packlist
 
 EOP
 }