Skip to content

Commit

Permalink
Fix up some repo details for continued maintenance (#68)
Browse files Browse the repository at this point in the history 
* Turn Makefile.PL into a modulino

* Show current maintainer (brian d foy)

* Need to handle default package MY for SUPER to work out

* Update the minimum Perl to v5.10

Pod::Man and podlators, which do the heavy lifting, require this.

* Update current maintainer
  • Loading branch information
@briandfoy
briandfoy authored Dec 8, 2023
1 parent 34392b6 commit 797c49c
Show file tree
Hide file tree
Showing 13 changed files with 172 additions and 89 deletions.
200 changes: 141 additions & 59 deletions Makefile.PL
View file
Original file line number Diff line number Diff line change
@@ -1,61 +1,3 @@
use 5.006;
use strict;
use warnings;

use ExtUtils::MakeMaker;

my $EUMM_VERSION = $ExtUtils::MakeMaker::VERSION;

WriteMakefile(
'NAME' => 'Pod::Perldoc',
'VERSION_FROM' => 'lib/Pod/Perldoc.pm',

'AUTHOR' => 'Mark Allen <[email protected]>', # maintainer
'ABSTRACT_FROM' => 'lib/Pod/Perldoc.pm',

'PREREQ_PM' => {
# Are there any hard dependencies not covered here?
'Config' => '0',
'Encode' => '0',
'Fcntl' => '0',
'File::Spec::Functions' => '0',
'File::Temp' => '0.22',
'IO::Select' => '0',
'parent' => '0',
'Pod::Man' => '2.18',
'Pod::Simple::RTF' => '3.16',
'Pod::Simple::XMLOutStream' => '3.16',
'Pod::Text' => '0',
'strict' => '0',
'Symbol' => '0',
'Test::More' => '0',
'Text::ParseWords' => '0',
'warnings' => '0',
},

($ENV{PERL_CORE} ? () : ('EXE_FILES' => [qw( perldoc )])),

'META_MERGE' => {
no_index => {
directory => 'corpus',
},
resources => {
repository => 'https://github.com/mrallen1/Pod-Perldoc.git',
},
},

($ENV{PERL_CORE} ? () :
('MAN1PODS' => { 'perldoc.pod' => 'blib/man1/perldoc.1' })),

($^V >= 5.008001 && $^V < 5.012 ? ( 'INSTALLDIRS' => 'perl' ) : ()),

( $EUMM_VERSION > 6.31 ? (
'LICENSE' => 'perl',
) : () ),

test => {TESTS => 't/*.t t/*/*.t'}
);

package MY;

sub libscan
Expand All @@ -74,4 +16,144 @@ sub init_dirscan
return;
}

__END__

package Pod::Perldoc;
use strict;
use warnings;

=encoding utf8
=head1 The build file for Pod::Perldoc
This build file is a modulino; it works as both a build script and
a module.
To build the distribution, run this file normally:
% perl Makefile.PL
But, it's more interesting than that. You can load it with C<require>
and call C<arguments> to get the data structure it passes to
C<WriteMakefile>:
my $package = require '/path/to/Makefile.PL';
my $arguments = $package->arguments;
Note that C<require>-ing a file makes an entry in C<%INC> for exactly
that name. If you try to C<require> another file with the same name,
even from a different path, C<require> thinks it has already loaded
the file. As such, I recommend you always require the full path to the
file.
The return value of the C<require> is a package name (in this case,
the name of the main module. Use that to call the C<arguments> method.
Even if this distribution needs a higher version of Perl, this bit
only needs v5.8. You can play with the data structure with a primitive
Perl.
=cut

use ExtUtils::MakeMaker;
use File::Spec::Functions qw(catfile);

my $module = __PACKAGE__;
( my $dist = $module ) =~ s/::/-/g;

my $github = 'https://github.com/briandfoy/pod-perldoc';
my $main_file = catfile( 'lib', split /::/, "$module.pm" );

my %WriteMakefile = (
'MIN_PERL_VERSION' => '5.010',

'NAME' => $module,
'ABSTRACT_FROM' => $main_file,
'VERSION_FROM' => $main_file,
'AUTHOR' => 'Sean M. Burke <[email protected]>', # maintained by brian d foy, [email protected]

'CONFIGURE_REQUIRES' => {
'ExtUtils::MakeMaker' => '6.64',
'File::Spec::Functions' => '0',
},

'BUILD_REQUIRES' => {
},

'TEST_REQUIRES' => {
'Test::More' => '1',
},

'PREREQ_PM' => {
'Config' => '0',
'Encode' => '0',
'Fcntl' => '0',
'File::Spec::Functions' => '0',
'File::Temp' => '0.22',
'IO::Select' => '0',
'parent' => '0',
'Pod::Man' => '2.18',
'Pod::Simple::RTF' => '3.16',
'Pod::Simple::XMLOutStream' => '3.16',
'Pod::Text' => '0',
'strict' => '0',
'Symbol' => '0',
'Test::More' => '0',
'Text::ParseWords' => '0',
'warnings' => '0',
},

'META_MERGE' => {
'meta-spec' => { version => 2 },
no_index => {
directory => 'corpus',
},
resources => {
repository => {
type => 'git',
url => $github,
web => $github,
},
homepage => $github,
},
},

( ExtUtils::MakeMaker->VERSION > 6.31 ? ( 'LICENSE' => 'perl' ) : () ),

( $ENV{PERL_CORE} ? () : (
'MAN1PODS' => { 'perldoc.pod' => 'blib/man1/perldoc.1' },
'EXE_FILES' => [qw( perldoc )],
)
),


($^V >= 5.008001 && $^V < 5.012 ? ( 'INSTALLDIRS' => 'perl' ) : ()),

test => {TESTS => 't/*.t t/*/*.t'},

'clean' => { FILES => "$dist-*" },
);

sub arguments { \%WriteMakefile }

do_it() unless caller;
sub do_it {
require File::Spec;
my $MM ='ExtUtils::MakeMaker';
my $MM_version =
eval{ "$MM " . $WriteMakefile{'CONFIGURE_REQUIRES'}{'ExtUtils::MakeMaker'} }
||
"$MM 6.64";
eval "use $MM_version; 1" or die "Could not load $MM_version: $@";
eval "use Test::Manifest 1.21"
if -e File::Spec->catfile( qw(t test_manifest) );

my $arguments = arguments();
my $minimum_perl = $arguments->{MIN_PERL_VERSION} || '5.008';
eval "require $minimum_perl;" or die $@;

WriteMakefile( %$arguments );
}

no warnings;

__PACKAGE__;
7 changes: 4 additions & 3 deletions lib/Pod/Perldoc.pm
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use 5.006; # we use some open(X, "<", $y) syntax
use 5.010; # podlaters and Pod::Man require this

package Pod::Perldoc;
use strict;
Expand Down Expand Up @@ -2147,11 +2147,12 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
=cut
4 changes: 2 additions & 2 deletions lib/Pod/Perldoc/BaseTo.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,10 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
Expand Down
4 changes: 2 additions & 2 deletions lib/Pod/Perldoc/GetOptsOO.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,10 +151,10 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
Expand Down
6 changes: 3 additions & 3 deletions lib/Pod/Perldoc/ToANSI.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ sub parse_from_file {

=head1 NAME
Pod::Perldoc::ToANSI - render Pod with ANSI color escapes
Pod::Perldoc::ToANSI - render Pod with ANSI color escapes
=head1 SYNOPSIS
Expand Down Expand Up @@ -85,10 +85,10 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
Expand Down
4 changes: 2 additions & 2 deletions lib/Pod/Perldoc/ToChecker.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
Expand Down
6 changes: 3 additions & 3 deletions lib/Pod/Perldoc/ToMan.pm
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
require 5.006;
require 5.010; # Pod::Man requires this
package Pod::Perldoc::ToMan;
use strict;
use warnings;
Expand Down Expand Up @@ -559,10 +559,10 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
Expand Down
4 changes: 2 additions & 2 deletions lib/Pod/Perldoc/ToNroff.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,10 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
Expand Down
4 changes: 2 additions & 2 deletions lib/Pod/Perldoc/ToPod.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <mallencpan.org> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
Expand Down
4 changes: 2 additions & 2 deletions lib/Pod/Perldoc/ToRtf.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
Expand Down
5 changes: 2 additions & 3 deletions lib/Pod/Perldoc/ToText.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,12 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
=cut

8 changes: 4 additions & 4 deletions lib/Pod/Perldoc/ToTk.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,12 @@ L<Tk::Pod>, L<Pod::Perldoc>
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>;
Sean M. Burke C<< <[email protected]> >>;
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
significant portions copied from
F<tkpod> in the Tk::Pod dist, by Nick Ing-Simmons, Slaven Rezic, et al.
Expand Down
5 changes: 3 additions & 2 deletions lib/Pod/Perldoc/ToXml.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,13 @@ merchantability or fitness for a particular purpose.
=head1 AUTHOR
Current maintainer: Mark Allen C<< <[email protected]> >>
Current maintainer: brian d foy C<< <[email protected]> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Mark Allen C<< <mallen@cpan.org> >>
Adriano R. Ferreira C<< <[email protected]> >>,
Sean M. Burke C<< <[email protected]> >>
=cut

0 comments on commit 797c49c

Please sign in to comment.