This queue is for tickets about the Module-Install CPAN distribution.

Report information
The Basics
Id:
70306
Status:
open
Priority:
Low/Low

People
Owner:
Nobody in particular
Requestors:
florent.angly [...] gmail.com
Cc:
AdminCc:

BugTracker
Severity:
Wishlist
Broken in:
(no value)
Fixed in:
(no value)



Subject: POD to README in the build process
It would be nice to have a facility in Module::Install that would allow users or package maintainers to generate a README file based on the POD content of a Perl file whenever they are configuring/building a module under Module::Install. For example, in the attached script, I added directive in my Makefile.PL to generate the README and README.htm files of my package using the pod2text and pod2html tools, which are bundled with Perl. This means that the README file are synchronized with the POD content eveytime 'perl Makefile.PL' is called.
Subject: Makefile.PL
use inc::Module::Install; use File::Spec::Functions; # Package information name 'Grinder'; all_from 'lib/Grinder.pm'; resources homepage 'http://sourceforge.net/projects/biogrinder/'; bugtracker 'http://sourceforge.net/tracker/?group_id=244196&atid=1124737'; repository 'git://biogrinder.git.sourceforge.net/gitroot/biogrinder/biogrinder'; # Dependencies build_requires 'Test::More'; # Regular Perl module dependencies for Grinder requires 'Getopt::Euclid' => '0.2.4'; requires 'Math::Random::MT::Perl' => '1.06'; requires 'Bio::SeqIO' => 0; #required 'Bio::Seq::SimulatedRead' => 0; # required but packaged here since it is so recent auto_install; # process dependencies # Extra scripts to install install_script 'script/grinder'; install_script 'utils/average_genome_size'; install_script 'utils/change_paired_read_orientation'; # Generate META.yml and Makefile WriteAll; # Build the README from the module's POD using Perl's pod2text and pod2html generate_readme(); #--------- UTILS --------------------------------------------------------------# sub generate_readme { print "*** Building README files...\n"; my $source = catfile('lib','Grinder.pm'); generate_readme_text( $source, 'README' ); generate_readme_html( $source, 'README.htm' ); return 1; } sub generate_readme_text { my ($in, $out) = @_; `pod2text $in $out`; warn "Warning: Could not generate $out.\n$!\n" if $? == -1; return $?; # exit status } sub generate_readme_html { my ($in, $out) = @_; `pod2html --infile=$in --outfile=$out`; warn "Warning: Could not generate $out.\n$!\n" if $? == -1; rm_files(['pod2htmd.tmp', 'pod2htmi.tmp']); return $?; # exit status } sub rm_files { my ($files) = @_; for my $file (@$files) { if (-e $file) { unlink $file or warn "Warning: Could not remove file '$file'.\n$!\n"; } } return 1; }
On Wed Aug 17 01:43:05 2011, FANGLY wrote:
Show quoted text
> It would be nice to have a facility in Module::Install that would allow > users or package maintainers to generate a README file based on the POD > content of a Perl file whenever they are configuring/building a module > under Module::Install. > > For example, in the attached script, I added directive in my Makefile.PL > to generate the README and README.htm files of my package using the > pod2text and pod2html tools, which are bundled with Perl. This means > that the README file are synchronized with the POD content eveytime > 'perl Makefile.PL' is called. >
This would be a really nice feature.


This service runs on Request Tracker, is sponsored by The Perl Foundation, and maintained by Best Practical Solutions.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.