X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=maint%2FMakefile.PL.inc%2F53_autogen_pod.pl;h=fb222eea0d29054ec7996f7e9ec55f93e12541c6;hb=e01fd1cb593cf66ee6016ad6de89706f02d56ffe;hp=5d68f657137646d0bd10eb0cd58fa5917938c965;hpb=3e2a5d5d6b3b941870b99a80531122126466a918;p=dbsrgits%2FDBIx-Class.git diff --git a/maint/Makefile.PL.inc/53_autogen_pod.pl b/maint/Makefile.PL.inc/53_autogen_pod.pl index 5d68f65..fb222ee 100644 --- 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"); @@ -37,13 +40,48 @@ EOP } -# generate the inherit pods both in the clone-dir and during the makefile distdir +# generate the script/dbicadmin pod { - print "Regenerating project documentation to include inherited methods\n"; + print "Regenerating script/dbicadmin.pod\n"; + + # generating it in the root of $pod_dir + # it will *not* be copied over due to not being listed at the top + # of MANIFEST.SKIP - this is a *good* thing + # we only want to ship a script/dbicadmin, with the POD appended + # (see inject_dbicadmin_pod.pl), but still want to spellcheck and + # whatnot the intermediate step + my $pod_fn = "$pod_dir/dbicadmin.pod"; + + # if the author doesn't have the prereqs, don't fail the initial "perl Makefile.pl" step + 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"; - # if the author doesn't have them, don't fail the initial "perl Makefile.pl" step - do "maint/gen_pod_inherit" or print "\n!!! FAILED: $@\n"; +clonedir_generate_files : dbic_clonedir_gen_dbicadmin_pod +dbic_clonedir_gen_dbicadmin_pod : +\t\$(ABSPERLRUN) -Ilib -- script/dbicadmin --documentation-as-pod @{[ $mm_proto->quote_literal($pod_fn) ]} + +EOP +} + + +# generate the inherit pods only during distbuilding phase +# it is too slow to do at regular Makefile.PL +{ postamble <<"EOP"; clonedir_generate_files : dbic_clonedir_gen_inherit_pods @@ -55,8 +93,25 @@ EOP } -# copy the contents of $pod_dir over to the workdir -# (yes, overwriting is fine, though nothing should reside there) +# 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) +if ($^O eq 'MSWin32' or $^O eq 'cygwin') { + { + local $ENV{PERLIO} = 'unix'; + system( $^X, qw( -MExtUtils::Command -e dos2unix -- ), $pod_dir ); + } + + postamble <<"EOP"; + +clonedir_post_generate_files : pod_crlf_fixup + +pod_crlf_fixup : +@{[ $crlf_fixup->($pod_dir) ]} + +EOP +} + { postamble <<"EOP"; @@ -67,6 +122,7 @@ dbic_clonedir_copy_generated_pod : \t@{[ $mm_proto->oneliner("install([ from_to => {q($pod_dir) => File::Spec->curdir(), write => q($pod_dir.packlist)}, verbose => 0, uninstall_shadows => 0, skip => [] ])", ['-MExtUtils::Install']) ]} + EOP } @@ -78,9 +134,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 }