X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/75e2e5517808856c2615c78c5ca3267b18bff381..b5b9b3855f771d1ed1aaa79a547b12ee1f8a218b:/lib/ExtUtils/MakeMaker.pm?ds=sidebyside diff --git a/lib/ExtUtils/MakeMaker.pm b/lib/ExtUtils/MakeMaker.pm index a505b15..314c5d0 100644 --- a/lib/ExtUtils/MakeMaker.pm +++ b/lib/ExtUtils/MakeMaker.pm @@ -1,28 +1,35 @@ -BEGIN {require 5.004;} - +# $Id$ package ExtUtils::MakeMaker; -$VERSION = "5.54_01"; -$Version_OK = "5.49"; # Makefiles older than $Version_OK will die - # (Will be checked from MakeMaker version 4.13 onwards) -($Revision = substr(q$Revision: 1.23 $, 10)) =~ s/\s+$//; +use strict; + +BEGIN {require 5.006;} require Exporter; -use Config; +use ExtUtils::MakeMaker::Config; use Carp (); +use File::Path; -use vars qw( - @ISA @EXPORT @EXPORT_OK - $ISA_TTY $Revision $VERSION $Verbose $Version_OK %Config - %Keep_after_flush %MM_Sections @Prepend_dot_dot - %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable - @Parent $PACKNAME - ); -use strict; +our $Verbose = 0; # exported +our @Parent; # needs to be localized +our @Get_from_Config; # referenced by MM_Unix +our @MM_Sections; +our @Overridable; +my @Prepend_parent; +my %Recognized_Att_Keys; + +our $VERSION = '6.48'; -@ISA = qw(Exporter); -@EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt); -@EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists); +# Emulate something resembling CVS $Revision$ +(our $Revision = $VERSION) =~ s{_}{}; +$Revision = int $Revision * 10000; + +our $Filename = __FILE__; # referenced outside MakeMaker + +our @ISA = qw(Exporter); +our @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt); +our @EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists + &WriteEmptyMakefile); # These will go away once the last of the Win32 & VMS specific code is # purged. @@ -34,33 +41,127 @@ full_setup(); require ExtUtils::MM; # Things like CPAN assume loading ExtUtils::MakeMaker # will give them MM. -sub warnhandler { - $_[0] =~ /^Use of uninitialized value/ && return; - $_[0] =~ /used only once/ && return; - $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return; - warn @_; -} +require ExtUtils::MY; # XXX pre-5.8 versions of ExtUtils::Embed expect + # loading ExtUtils::MakeMaker will give them MY. + # This will go when Embed is its own CPAN module. + sub WriteMakefile { Carp::croak "WriteMakefile: Need even number of args" if @_ % 2; - local $SIG{__WARN__} = \&warnhandler; require ExtUtils::MY; my %att = @_; - MM->new(\%att)->flush; + + _verify_att(\%att); + + my $mm = MM->new(\%att); + $mm->flush; + + return $mm; } -sub prompt ($;$) { - my($mess,$def)=@_; - $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe? - Carp::confess("prompt function called without an argument") unless defined $mess; + +# Basic signatures of the attributes WriteMakefile takes. Each is the +# reference type. Empty value indicate it takes a non-reference +# scalar. +my %Att_Sigs; +my %Special_Sigs = ( + C => 'ARRAY', + CONFIG => 'ARRAY', + CONFIGURE => 'CODE', + DIR => 'ARRAY', + DL_FUNCS => 'HASH', + DL_VARS => 'ARRAY', + EXCLUDE_EXT => 'ARRAY', + EXE_FILES => 'ARRAY', + FUNCLIST => 'ARRAY', + H => 'ARRAY', + IMPORTS => 'HASH', + INCLUDE_EXT => 'ARRAY', + LIBS => ['ARRAY',''], + MAN1PODS => 'HASH', + MAN3PODS => 'HASH', + META_ADD => 'HASH', + META_MERGE => 'HASH', + PL_FILES => 'HASH', + PM => 'HASH', + PMLIBDIRS => 'ARRAY', + PMLIBPARENTDIRS => 'ARRAY', + PREREQ_PM => 'HASH', + SKIP => 'ARRAY', + TYPEMAPS => 'ARRAY', + XS => 'HASH', + VERSION => ['version',''], + _KEEP_AFTER_FLUSH => '', + + clean => 'HASH', + depend => 'HASH', + dist => 'HASH', + dynamic_lib=> 'HASH', + linkext => 'HASH', + macro => 'HASH', + postamble => 'HASH', + realclean => 'HASH', + test => 'HASH', + tool_autosplit => 'HASH', +); + +@Att_Sigs{keys %Recognized_Att_Keys} = ('') x keys %Recognized_Att_Keys; +@Att_Sigs{keys %Special_Sigs} = values %Special_Sigs; + + +sub _verify_att { + my($att) = @_; + + while( my($key, $val) = each %$att ) { + my $sig = $Att_Sigs{$key}; + unless( defined $sig ) { + warn "WARNING: $key is not a known parameter.\n"; + next; + } + + my @sigs = ref $sig ? @$sig : $sig; + my $given = ref $val; + unless( grep { $given eq $_ || ($_ && eval{$val->isa($_)}) } @sigs ) { + my $takes = join " or ", map { _format_att($_) } @sigs; + + my $has = _format_att($given); + warn "WARNING: $key takes a $takes not a $has.\n". + " Please inform the author.\n"; + } + } +} + + +sub _format_att { + my $given = shift; + + return $given eq '' ? "string/number" + : uc $given eq $given ? "$given reference" + : "$given object" + ; +} + + +sub prompt ($;$) { ## no critic + my($mess, $def) = @_; + Carp::confess("prompt function called without an argument") + unless defined $mess; + + my $isa_tty = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; + my $dispdef = defined $def ? "[$def] " : " "; $def = defined $def ? $def : ""; - my $ans; + local $|=1; local $\; print "$mess $dispdef"; - if ($ISA_TTY && !$ENV{PERL_MM_USE_DEFAULT}) { + + my $ans; + if ($ENV{PERL_MM_USE_DEFAULT} || (!$isa_tty && eof STDIN)) { + print "$def\n"; + } + else { $ans = ; if( defined $ans ) { chomp $ans; @@ -69,24 +170,25 @@ sub prompt ($;$) { print "\n"; } } - else { - print "$def\n"; - } + return (!defined $ans || $ans eq '') ? $def : $ans; } sub eval_in_subdirs { my($self) = @_; use Cwd qw(cwd abs_path); - my $pwd = cwd(); + my $pwd = cwd() || die "Can't figure out your cwd!"; + local @INC = map eval {abs_path($_) if -e} || $_, @INC; push @INC, '.'; # '.' has to always be at the end of @INC foreach my $dir (@{$self->{DIR}}){ my($abs) = $self->catdir($pwd,$dir); - $self->eval_in_x($abs); + eval { $self->eval_in_x($abs); }; + last if $@; } chdir $pwd; + die $@ if $@; } sub eval_in_x { @@ -103,39 +205,51 @@ sub eval_in_x { # } else { # warn "WARNING from evaluation of $dir/Makefile.PL: $@"; # } - warn "WARNING from evaluation of $dir/Makefile.PL: $@"; + die "ERROR from evaluation of $dir/Makefile.PL: $@"; } } + +# package name for the classes into which the first object will be blessed +my $PACKNAME = 'PACK000'; + sub full_setup { $Verbose ||= 0; - # package name for the classes into which the first object will be blessed - $PACKNAME = "PACK000"; - my @attrib_help = qw/ AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS - EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE + EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FULLPERLRUN FULLPERLRUNINST FUNCLIST H IMPORTS - INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS - INSTALLMAN1DIR - INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH - INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB - INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS - LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB - PERL_MALLOC_OK - NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC - PERLRUN PERLRUNINST PERL_ARCHLIB PERL_CORE - PERL_LIB PERL_SRC PERM_RW PERM_RWX - PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC - PPM_INSTALL_SCRIPT PREFIX - PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ - SKIP TEST_LIBS TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG + + INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR + INSTALLDIRS + DESTDIR PREFIX INSTALL_BASE + PERLPREFIX SITEPREFIX VENDORPREFIX + INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB + INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH + INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN + INSTALLMAN1DIR INSTALLMAN3DIR + INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR + INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR + INSTALLSCRIPT INSTALLSITESCRIPT INSTALLVENDORSCRIPT + PERL_LIB PERL_ARCHLIB + SITELIBEXP SITEARCHEXP + + INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS LICENSE + LINKTYPE MAKE MAKEAPERL MAKEFILE MAKEFILE_OLD MAN1PODS MAN3PODS MAP_TARGET + META_ADD META_MERGE MIN_PERL_VERSION + MYEXTLIB NAME NEEDS_LINKING NOECHO NO_META NORECURS NO_VC OBJECT OPTIMIZE + PERL_MALLOC_OK PERL PERLMAINCC PERLRUN PERLRUNINST PERL_CORE + PERL_SRC PERM_RW PERM_RWX + PL_FILES PM PM_FILTER PMLIBDIRS PMLIBPARENTDIRS POLLUTE PPM_INSTALL_EXEC + PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ + SIGN SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG XS_VERSION clean depend dist dynamic_lib linkext macro realclean tool_autosplit + MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED /; @@ -154,16 +268,24 @@ sub full_setup { @MM_Sections = qw( - post_initialize const_config constants tool_autosplit tool_xsubpp - tools_other dist macro depend cflags const_loadlibs const_cccmd + post_initialize const_config constants platform_constants + tool_autosplit tool_xsubpp tools_other + + makemakerdflt + + dist macro depend cflags const_loadlibs const_cccmd post_constants pasthru - c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs + special_targets + c_o xs_c xs_o + top_targets blibdirs linkext dlsyms dynamic dynamic_bs dynamic_lib static static_lib manifypods processPL installbin subdirs - clean realclean dist_basics dist_core dist_dir dist_test dist_ci + clean_subdirs clean realclean_subdirs realclean + metafile signature + dist_basics dist_core distdir dist_test dist_ci distmeta distsignature install force perldepend makefile staticmake test ppd ); # loses section ordering @@ -171,8 +293,11 @@ sub full_setup { @Overridable = @MM_Sections; push @Overridable, qw[ - dir_target libscan makeaperl needs_linking perm_rw perm_rwx - subdir_x test_via_harness test_via_script init_PERL + libscan makeaperl needs_linking perm_rw perm_rwx + subdir_x test_via_harness test_via_script + + init_VERSION init_dist init_INST init_INSTALL init_DEST init_dirscan + init_PM init_MANPODS init_xs init_PERL init_DIRFILESEP init_linker ]; push @MM_Sections, qw[ @@ -191,11 +316,14 @@ sub full_setup { # we will use all these variables in the Makefile @Get_from_Config = qw( - ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc - lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so - exe_ext full_ar + ar cc cccdlflags ccdlflags dlext dlsrc exe_ext full_ar ld + lddlflags ldflags libc lib_ext obj_ext osname osvers ranlib + sitelibexp sitearchexp so ); + # 5.5.3 doesn't have any concept of vendor libs + push @Get_from_Config, qw( vendorarchexp vendorlibexp ) if $] >= 5.006; + foreach my $item (@attrib_help){ $Recognized_Att_Keys{$item} = 1; } @@ -210,16 +338,11 @@ sub full_setup { # us (the parent) for the values and will prepend "..", so that # all files to be installed end up below OUR ./blib # - @Prepend_dot_dot = qw( - INST_BIN INST_EXE INST_LIB INST_ARCHLIB INST_SCRIPT + @Prepend_parent = qw( + INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC PERL FULLPERL ); - - my @keep = qw/ - NEEDS_LINKING HAS_LINK_CODE - /; - @Keep_after_flush{@keep} = (1) x @keep; } sub writeMakefile { @@ -246,14 +369,29 @@ sub new { my($class,$self) = @_; my($key); + # Store the original args passed to WriteMakefile() + foreach my $k (keys %$self) { + $self->{ARGS}{$k} = $self->{$k}; + } + if ("@ARGV" =~ /\bPREREQ_PRINT\b/) { require Data::Dumper; - print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]); + my @what = ('PREREQ_PM'); + push @what, 'MIN_PERL_VERSION' if $self->{MIN_PERL_VERSION}; + print Data::Dumper->Dump([@{$self}{@what}], \@what); + exit 0; } # PRINT_PREREQ is RedHatism. if ("@ARGV" =~ /\bPRINT_PREREQ\b/) { - print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n"; + my @prereq = + map { [$_, $self->{PREREQ_PM}{$_}] } keys %{$self->{PREREQ_PM}}; + if ( $self->{MIN_PERL_VERSION} ) { + push @prereq, ['perl' => $self->{MIN_PERL_VERSION}]; + } + + print join(" ", map { "perl($_->[0])>=$_->[1] " } + sort { $a->[0] cmp $b->[0] } @prereq), "\n"; exit 0; } @@ -266,34 +404,81 @@ sub new { check_hints($self); + # Translate X.Y.Z to X.00Y00Z + if( defined $self->{MIN_PERL_VERSION} ) { + $self->{MIN_PERL_VERSION} =~ s{ ^ (\d+) \. (\d+) \. (\d+) $ } + {sprintf "%d.%03d%03d", $1, $2, $3}ex; + } + + my $perl_version_ok = eval { + local $SIG{__WARN__} = sub { + # simulate "use warnings FATAL => 'all'" for vintage perls + die @_; + }; + !$self->{MIN_PERL_VERSION} or $self->{MIN_PERL_VERSION} <= $] + }; + if (!$perl_version_ok) { + if (!defined $perl_version_ok) { + warn <<'END'; +Warning: MIN_PERL_VERSION is not in a recognized format. +Recommended is a quoted numerical value like '5.005' or '5.008001'. +END + } + elsif ($self->{PREREQ_FATAL}) { + die sprintf <<"END", $self->{MIN_PERL_VERSION}, $]; +MakeMaker FATAL: perl version too low for this distribution. +Required is %s. We run %s. +END + } + else { + warn sprintf + "Warning: Perl version %s or higher required. We run %s.\n", + $self->{MIN_PERL_VERSION}, $]; + } + } + my %configure_att; # record &{$self->{CONFIGURE}} attributes my(%initial_att) = %$self; # record initial attributes my(%unsatisfied) = (); foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) { - eval "require $prereq"; + # 5.8.0 has a bug with require Foo::Bar alone in an eval, so an + # extra statement is a workaround. + my $file = "$prereq.pm"; + $file =~ s{::}{/}g; + eval { require $file }; + + my $pr_version = $prereq->VERSION || 0; + + # convert X.Y_Z alpha version #s to X.YZ for easier comparisons + $pr_version =~ s/(\d+)\.(\d+)_(\d+)/$1.$2$3/; if ($@) { warn sprintf "Warning: prerequisite %s %s not found.\n", $prereq, $self->{PREREQ_PM}{$prereq} unless $self->{PREREQ_FATAL}; $unsatisfied{$prereq} = 'not installed'; - } elsif ($prereq->VERSION < $self->{PREREQ_PM}->{$prereq} ){ - warn "Warning: prerequisite %s %s not found. We have %s.\n", + } elsif ($pr_version < $self->{PREREQ_PM}->{$prereq} ){ + warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n", $prereq, $self->{PREREQ_PM}{$prereq}, - ($prereq->VERSION || 'unknown version') + ($pr_version || 'unknown version') unless $self->{PREREQ_FATAL}; $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ? $self->{PREREQ_PM}->{$prereq} : 'unknown version' ; } } - if (%unsatisfied && $self->{PREREQ_FATAL}){ - my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"} - keys %unsatisfied; - die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)\n - Please install these modules first and rerun 'perl Makefile.PL'.\n}; + + if (%unsatisfied && $self->{PREREQ_FATAL}){ + my $failedprereqs = join "\n", map {" $_ $unsatisfied{$_}"} + sort { $a cmp $b } keys %unsatisfied; + die <<"END"; +MakeMaker FATAL: prerequisites not found. +$failedprereqs + +Please install these modules first and rerun 'perl Makefile.PL'. +END } - + if (defined $self->{CONFIGURE}) { if (ref $self->{CONFIGURE} eq 'CODE') { %configure_att = %{&{$self->{CONFIGURE}}}; @@ -311,22 +496,28 @@ sub new { my $newclass = ++$PACKNAME; local @Parent = @Parent; # Protect against non-local exits { - no strict 'refs'; print "Blessing Object into class [$newclass]\n" if $Verbose>=2; mv_all_methods("MY",$newclass); bless $self, $newclass; push @Parent, $self; require ExtUtils::MY; + + no strict 'refs'; ## no critic; @{"$newclass\:\:ISA"} = 'MM'; } if (defined $Parent[-2]){ $self->{PARENT} = $Parent[-2]; - my $key; - for $key (@Prepend_dot_dot) { + for my $key (@Prepend_parent) { next unless defined $self->{PARENT}{$key}; + + # Don't stomp on WriteMakefile() args. + next if defined $self->{ARGS}{$key} and + $self->{ARGS}{$key} eq $self->{$key}; + $self->{$key} = $self->{PARENT}{$key}; - unless ($^O eq 'VMS' && $key =~ /PERL$/) { + + unless ($Is_VMS && $key =~ /PERL$/) { $self->{$key} = $self->catdir("..",$self->{$key}) unless $self->file_name_is_absolute($self->{$key}); } else { @@ -343,7 +534,7 @@ sub new { } if ($self->{PARENT}) { $self->{PARENT}->{CHILDREN}->{$newclass} = $self; - foreach my $opt (qw(POLLUTE PERL_CORE)) { + foreach my $opt (qw(POLLUTE PERL_CORE LINKTYPE)) { if (exists $self->{PARENT}->{$opt} and not exists $self->{$opt}) { @@ -358,11 +549,26 @@ sub new { parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV); } + $self->{NAME} ||= $self->guess_name; ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g; - $self->init_main(); + $self->init_MAKE; + $self->init_main; + $self->init_VERSION; + $self->init_dist; + $self->init_INST; + $self->init_INSTALL; + $self->init_DEST; + $self->init_dirscan; + $self->init_PM; + $self->init_MANPODS; + $self->init_xs; + $self->init_PERL; + $self->init_DIRFILESEP; + $self->init_linker; + $self->init_ABSTRACT; if (! $self->{PERL_SRC} ) { require VMS::Filespec if $Is_VMS; @@ -389,8 +595,9 @@ END } } - $self->init_dirscan(); $self->init_others(); + $self->init_platform(); + $self->init_PERM(); my($argv) = neatvalue(\@ARGV); $argv =~ s/^\[/(/; $argv =~ s/\]$/)/; @@ -410,6 +617,8 @@ END END foreach my $key (sort keys %initial_att){ + next if $key eq 'ARGS'; + my($v) = neatvalue($initial_att{$key}); $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/; $v =~ tr/\n/ /s; @@ -424,6 +633,7 @@ END END if (scalar(keys %configure_att) > 0) { foreach my $key (sort keys %configure_att){ + next if $key eq 'ARGS'; my($v) = neatvalue($configure_att{$key}); $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/; $v =~ tr/\n/ /s; @@ -438,14 +648,13 @@ END } # turn the SKIP array into a SKIPHASH hash - my (%skip,$skip); - for $skip (@{$self->{SKIP} || []}) { + for my $skip (@{$self->{SKIP} || []}) { $self->{SKIPHASH}{$skip} = 1; } delete $self->{SKIP}; # free memory if ($self->{PARENT}) { - for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) { + for (qw/install dist dist_basics dist_core distdir dist_test dist_ci/) { $self->{SKIPHASH}{$_} = 1; } } @@ -457,6 +666,10 @@ END } foreach my $section ( @MM_Sections ){ + # Support for new foo_target() methods. + my $method = $section; + $method .= '_target' unless $self->can($method); + print "Processing Makefile '$section' section\n" if ($Verbose >= 2); my($skipit) = $self->skipcheck($section); if ($skipit){ @@ -465,7 +678,9 @@ END my(%a) = %{$self->{$section} || {}}; push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:"; push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a; - push @{$self->{RESULT}}, $self->nicetext($self->$section( %a )); + push @{$self->{RESULT}}, $self->maketext_filter( + $self->$method( %a ) + ); } } @@ -475,32 +690,33 @@ END } sub WriteEmptyMakefile { - Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2; - local $SIG{__WARN__} = \&warnhandler; + Carp::croak "WriteEmptyMakefile: Need an even number of args" if @_ % 2; my %att = @_; my $self = MM->new(\%att); - if (-f "$self->{MAKEFILE}.old") { - chmod 0666, "$self->{MAKEFILE}.old"; - unlink "$self->{MAKEFILE}.old" or warn "unlink $self->{MAKEFILE}.old: $!"; + + my $new = $self->{MAKEFILE}; + my $old = $self->{MAKEFILE_OLD}; + if (-f $old) { + _unlink($old) or warn "unlink $old: $!"; } - rename $self->{MAKEFILE}, "$self->{MAKEFILE}.old" - or warn "rename $self->{MAKEFILE} $self->{MAKEFILE}.old: $!" - if -f $self->{MAKEFILE}; - open MF, '>', $self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!"; - print MF <<'EOP'; -all: + if ( -f $new ) { + _rename($new, $old) or warn "rename $new => $old: $!" + } + open my $mfh, '>', $new or die "open $new for write: $!"; + print $mfh <<'EOP'; +all : -clean: +clean : -install: +install : -makemakerdflt: +makemakerdflt : -test: +test : EOP - close MF or die "close $self->{MAKEFILE} for write: $!"; + close $mfh or die "close $new for write: $!"; } sub check_manifest { @@ -523,7 +739,6 @@ sub parse_args{ my($self, @args) = @_; foreach (@args) { unless (m/(.*?)=(.*)/) { - help(),exit 1 if m/^help$/; ++$Verbose if m/^verb/; next; } @@ -535,7 +750,9 @@ sub parse_args{ (getpwuid($>))[7] ]ex; } - $self->{uc($name)} = $value; + + # Remember the original args passed it. It will be useful later. + $self->{ARGS}{uc $name} = $self->{uc $name} = $value; } # catch old-style 'potential_libs' and inform user how to 'upgrade' @@ -580,6 +797,7 @@ sub parse_args{ } foreach my $mmkey (sort keys %$self){ + next if $mmkey eq 'ARGS'; print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose; print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n" unless exists $Recognized_Att_Keys{$mmkey}; @@ -591,7 +809,11 @@ sub check_hints { my($self) = @_; # We allow extension-specific hints files. - return unless -d "hints"; + require File::Spec; + my $curdir = File::Spec->curdir; + + my $hint_dir = File::Spec->catdir($curdir, "hints"); + return unless -d $hint_dir; # First we look for the best hintsfile we have my($hint)="${^O}_$Config{osvers}"; @@ -601,11 +823,11 @@ sub check_hints { # Also try without trailing minor version numbers. while (1) { - last if -f "hints/$hint.pl"; # found + last if -f File::Spec->catfile($hint_dir, "$hint.pl"); # found } continue { last unless $hint =~ s/_[^_]*$//; # nothing to cut off } - my $hint_file = "hints/$hint.pl"; + my $hint_file = File::Spec->catfile($hint_dir, "$hint.pl"); return unless -f $hint_file; # really there @@ -617,24 +839,31 @@ sub _run_hintfile { local($self) = shift; # make $self available to the hint file. my($hint_file) = shift; - local $@; + local($@, $!); print STDERR "Processing hints file $hint_file\n"; - my $ret = do "./$hint_file"; - unless( defined $ret ) { - print STDERR $@ if $@; + + # Just in case the ./ isn't on the hint file, which File::Spec can + # often strip off, we bung the curdir into @INC + local @INC = (File::Spec->curdir, @INC); + my $ret = do $hint_file; + if( !defined $ret ) { + my $error = $@ || $!; + print STDERR $error; } } sub mv_all_methods { my($from,$to) = @_; - no strict 'refs'; - my($symtab) = \%{"${from}::"}; # Here you see the *current* list of methods that are overridable # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm # still trying to reduce the list to some reasonable minimum -- # because I want to make it easier for the user. A.K. + local $SIG{__WARN__} = sub { + # can't use 'no warnings redefined', 5.6 only + warn @_ unless $_[0] =~ /^Subroutine .* redefined/ + }; foreach my $method (@Overridable) { # We cannot say "next" here. Nick might call MY->makeaperl @@ -647,19 +876,23 @@ sub mv_all_methods { next unless defined &{"${from}::$method"}; - *{"${to}::$method"} = \&{"${from}::$method"}; - - # delete would do, if we were sure, nobody ever called - # MY->makeaperl directly - - # delete $symtab->{$method}; - - # If we delete a method, then it will be undefined and cannot - # be called. But as long as we have Makefile.PLs that rely on - # %MY:: being intact, we have to fill the hole with an - # inheriting method: - - eval "package MY; sub $method { shift->SUPER::$method(\@_); }"; + { + no strict 'refs'; ## no critic + *{"${to}::$method"} = \&{"${from}::$method"}; + + # If we delete a method, then it will be undefined and cannot + # be called. But as long as we have Makefile.PLs that rely on + # %MY:: being intact, we have to fill the hole with an + # inheriting method: + + { + package MY; + my $super = "SUPER::".$method; + *{$method} = sub { + shift->$super(@_); + }; + } + } } # We have to clean out %INC also, because the current directory is @@ -708,36 +941,51 @@ sub skipcheck { sub flush { my $self = shift; - my($chunk); -# use FileHandle (); -# my $fh = new FileHandle; - local *FH; - print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n"; - - unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : ''); -# $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!"; - open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!"; - - for $chunk (@{$self->{RESULT}}) { -# print $fh "$chunk\n"; - print FH "$chunk\n"; + + my $finalname = $self->{MAKEFILE}; + print STDOUT "Writing $finalname for $self->{NAME}\n"; + + unlink($finalname, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : ()); + open(my $fh,">", "MakeMaker.tmp") + or die "Unable to open MakeMaker.tmp: $!"; + + for my $chunk (@{$self->{RESULT}}) { + print $fh "$chunk\n"; } -# $fh->close; - close FH; - my($finalname) = $self->{MAKEFILE}; - rename("MakeMaker.tmp", $finalname); + close $fh; + _rename("MakeMaker.tmp", $finalname) or + warn "rename MakeMaker.tmp => $finalname: $!"; chmod 0644, $finalname unless $Is_VMS; - if ($self->{PARENT}) { + my %keep = map { ($_ => 1) } qw(NEEDS_LINKING HAS_LINK_CODE); + + if ($self->{PARENT} && !$self->{_KEEP_AFTER_FLUSH}) { foreach (keys %$self) { # safe memory - delete $self->{$_} unless $Keep_after_flush{$_}; + delete $self->{$_} unless $keep{$_}; } } system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":"; } + +# This is a rename for OS's where the target must be unlinked first. +sub _rename { + my($src, $dest) = @_; + chmod 0666, $dest; + unlink $dest; + return rename $src, $dest; +} + +# This is an unlink for OS's where the target must be writable first. +sub _unlink { + my @files = @_; + chmod 0666, @files; + return unlink @files; +} + + # The following mkbootstrap() is only for installations that are calling # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker # writes Makefiles, that use ExtUtils::Mkbootstrap directly. @@ -804,17 +1052,13 @@ __END__ =head1 NAME -ExtUtils::MakeMaker - create an extension Makefile +ExtUtils::MakeMaker - Create a module Makefile =head1 SYNOPSIS -C - -C VALUE [, ...] );> + use ExtUtils::MakeMaker; -which is really - -Cnew(\%att)-Eflush;> + WriteMakefile( ATTRIBUTE => VALUE [, ...] ); =head1 DESCRIPTION @@ -827,30 +1071,13 @@ that can be individually overridden. Each subroutine returns the text it wishes to have written to the Makefile. MakeMaker is object oriented. Each directory below the current -directory that contains a Makefile.PL. Is treated as a separate +directory that contains a Makefile.PL is treated as a separate object. This makes it possible to write an unlimited number of Makefiles with a single invocation of WriteMakefile(). =head2 How To Write A Makefile.PL -The short answer is: Don't. - - Always begin with h2xs. - Always begin with h2xs! - ALWAYS BEGIN WITH H2XS! - -even if you're not building around a header file, and even if you -don't have an XS component. - -Run h2xs(1) before you start thinking about writing a module. For so -called pm-only modules that consist of C<*.pm> files only, h2xs has -the C<-X> switch. This will generate dummy files of all kinds that are -useful for the module developer. - -The medium answer is: - - use ExtUtils::MakeMaker; - WriteMakefile( NAME => "Foo::Bar" ); +See ExtUtils::MakeMaker::Tutorial. The long answer is the rest of the manpage :-) @@ -866,7 +1093,7 @@ The generated Makefile enables the user of the extension to invoke The Makefile to be produced may be altered by adding arguments of the form C. E.g. - perl Makefile.PL PREFIX=/tmp/myperl5 + perl Makefile.PL INSTALL_BASE=~ Other interesting targets in the generated Makefile are @@ -879,14 +1106,17 @@ Other interesting targets in the generated Makefile are =head2 make test MakeMaker checks for the existence of a file named F in the -current directory and if it exists it adds commands to the test target -of the generated Makefile that will execute the script with the proper -set of perl C<-I> options. +current directory and if it exists it execute the script with the +proper set of perl C<-I> options. MakeMaker also checks for any files matching glob("t/*.t"). It will -add commands to the test target of the generated Makefile that execute -all matching files via the L module with the C<-I> -switches set correctly. +execute all matching files in alphabetical order via the +L module with the C<-I> switches set correctly. + +If you'd like to see the raw output of your tests, set the +C variable to true. + + make test TEST_VERBOSE=1 =head2 make testdb @@ -894,13 +1124,13 @@ A useful variation of the above is the target C. It runs the test under the Perl debugger (see L). If the file F exists in the current directory, it is used for the test. -If you want to debug some other testfile, set C variable +If you want to debug some other testfile, set the C variable thusly: make testdb TEST_FILE=t/mytest.t By default the debugger is called using C<-d> option to perl. If you -want to specify some other option, set C variable: +want to specify some other option, set the C variable: make testdb TESTDB_SW=-Dx @@ -919,14 +1149,15 @@ counterparts. Which counterparts are chosen depends on the setting of INSTALLDIRS according to the following table: INSTALLDIRS set to - perl site + perl site vendor - INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH - INST_LIB INSTALLPRIVLIB INSTALLSITELIB - INST_BIN INSTALLBIN - INST_SCRIPT INSTALLSCRIPT - INST_MAN1DIR INSTALLMAN1DIR - INST_MAN3DIR INSTALLMAN3DIR + PERLPREFIX SITEPREFIX VENDORPREFIX + INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH + INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB + INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN + INST_SCRIPT INSTALLSCRIPT INSTALLSITESCRIPT INSTALLVENDORSCRIPT + INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR + INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR The INSTALL... macros in turn default to their %Config ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts. @@ -940,18 +1171,60 @@ searched by perl, run perl -le 'print join $/, @INC' +Sometimes older versions of the module you're installing live in other +directories in @INC. Because Perl loads the first version of a module it +finds, not the newest, you might accidentally get one of these older +versions even after installing a brand new version. To delete I (not simply older ones) set the +C variable. + + make install UNINST=1 + + +=head2 INSTALL_BASE + +INSTALL_BASE can be passed into Makefile.PL to change where your +module will be installed. INSTALL_BASE is more like what everyone +else calls "prefix" than PREFIX is. + +To have everything installed in your home directory, do the following. + + # Unix users, INSTALL_BASE=~ works fine + perl Makefile.PL INSTALL_BASE=/path/to/your/home/dir + +Like PREFIX, it sets several INSTALL* attributes at once. Unlike +PREFIX it is easy to predict where the module will end up. The +installation pattern looks like this: + + INSTALLARCHLIB INSTALL_BASE/lib/perl5/$Config{archname} + INSTALLPRIVLIB INSTALL_BASE/lib/perl5 + INSTALLBIN INSTALL_BASE/bin + INSTALLSCRIPT INSTALL_BASE/bin + INSTALLMAN1DIR INSTALL_BASE/man/man1 + INSTALLMAN3DIR INSTALL_BASE/man/man3 + +INSTALL_BASE in MakeMaker and C<--install_base> in Module::Build (as +of 0.28) install to the same location. If you want MakeMaker and +Module::Build to install to the same location simply set INSTALL_BASE +and C<--install_base> to the same location. + +INSTALL_BASE was added in 6.31. + =head2 PREFIX and LIB attribute PREFIX and LIB can be used to set several INSTALL* attributes in one -go. The quickest way to install a module in a non-standard place might -be +go. Here's an example for installing into your home directory. - perl Makefile.PL PREFIX=~ + # Unix users, PREFIX=~ works fine + perl Makefile.PL PREFIX=/path/to/your/home/dir This will install all files in the module under your home directory, with man pages and libraries going into an appropriate place (usually -~/man and ~/lib). +~/man and ~/lib). How the exact location is determined is complicated +and depends on how your Perl was configured. INSTALL_BASE works more +like what other build systems call "prefix" than PREFIX and we +recommend you use that instead. Another way to specify many INSTALL directories with a single parameter is LIB. @@ -987,7 +1260,9 @@ relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate, and this incantation will be the best: - perl Makefile.PL; make; make test + perl Makefile.PL; + make; + make test make install make install per default writes some documentation of what has been @@ -1125,8 +1400,8 @@ recommends it (or you know what you're doing). =head2 Using Attributes and Parameters -The following attributes can be specified as arguments to WriteMakefile() -or as NAME=VALUE pairs on the command line: +The following attributes may be specified as arguments to WriteMakefile() +or as NAME=VALUE pairs on the command line. =over 2 @@ -1198,6 +1473,18 @@ be determined by some evaluation method. Something like C<"-DHAVE_UNISTD_H"> +=item DESTDIR + +This is the root directory into which the code will be installed. It +I. For example, if your code +would normally go into F you could set DESTDIR=~/tmp/ +and installation would go into F<~/tmp/usr/local/lib/perl>. + +This is primarily of use for people who repackage Perl modules. + +NOTE: Due to the nature of make, it is important that you put the trailing +slash on your DESTDIR. F<~/tmp/> not F<~/tmp>. + =item DIR Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm' @@ -1205,8 +1492,24 @@ Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm' =item DISTNAME -Your name for distributing the package (by tar file). This defaults to -NAME above. +A safe filename for the package. + +Defaults to NAME above but with :: replaced with -. + +For example, Foo::Bar becomes Foo-Bar. + +=item DISTVNAME + +Your name for distributing the package with the version number +included. This is used by 'make dist' to name the resulting archive +file. + +Defaults to DISTNAME-VERSION. + +For example, version 1.04 of Foo::Bar becomes Foo-Bar-1.04. + +On some OS's where . has special meaning VERSION_SYM may be used in +place of VERSION. =item DL_FUNCS @@ -1248,11 +1551,20 @@ Ref to array of executable files. The files will be copied to the INST_SCRIPT directory. Make realclean will delete them from there again. +If your executables start with something like #!perl or +#!/usr/bin/perl MakeMaker will change this to the path of the perl +'Makefile.PL' was invoked with so the programs will be sure to run +properly even if perl is not in /usr/bin/perl. + =item FIRST_MAKEFILE -The name of the Makefile to be produced. Defaults to the contents of -MAKEFILE, but can be overridden. This is used for the second Makefile -that will be produced for the MAP_TARGET. +The name of the Makefile to be produced. This is used for the second +Makefile that will be produced for the MAP_TARGET. + +Defaults to 'Makefile' or 'Descrip.MMS' on VMS. + +(Note: we couldn't use MAKEFILE because dmake uses this for something +else). =item FULLPERL @@ -1280,7 +1592,9 @@ Ref to array of *.h file names. Similar to C. =item IMPORTS This attribute is used to specify names to be imported into the -extension. It is only used on OS/2 and Win32. +extension. Takes a hash ref. + +It is only used on OS/2 and Win32. =item INC @@ -1308,45 +1622,94 @@ directory if INSTALLDIRS is set to perl. =item INSTALLBIN -Directory to install binary files (e.g. tkperl) into. +Directory to install binary files (e.g. tkperl) into if +INSTALLDIRS=perl. =item INSTALLDIRS -Determines which of the two sets of installation directories to -choose: installprivlib and installarchlib versus installsitelib and -installsitearch. The first pair is chosen with INSTALLDIRS=perl, the -second with INSTALLDIRS=site. Default is site. +Determines which of the sets of installation directories to choose: +perl, site or vendor. Defaults to site. =item INSTALLMAN1DIR -This directory gets the man pages at 'make install' time. Defaults to -$Config{installman1dir}. - =item INSTALLMAN3DIR -This directory gets the man pages at 'make install' time. Defaults to -$Config{installman3dir}. +These directories get the man pages at 'make install' time if +INSTALLDIRS=perl. Defaults to $Config{installman*dir}. + +If set to 'none', no man pages will be installed. =item INSTALLPRIVLIB Used by 'make install', which copies files from INST_LIB to this directory if INSTALLDIRS is set to perl. +Defaults to $Config{installprivlib}. + =item INSTALLSCRIPT Used by 'make install' which copies files from INST_SCRIPT to this -directory. +directory if INSTALLDIRS=perl. =item INSTALLSITEARCH Used by 'make install', which copies files from INST_ARCHLIB to this directory if INSTALLDIRS is set to site (default). +=item INSTALLSITEBIN + +Used by 'make install', which copies files from INST_BIN to this +directory if INSTALLDIRS is set to site (default). + =item INSTALLSITELIB Used by 'make install', which copies files from INST_LIB to this directory if INSTALLDIRS is set to site (default). +=item INSTALLSITEMAN1DIR + +=item INSTALLSITEMAN3DIR + +These directories get the man pages at 'make install' time if +INSTALLDIRS=site (default). Defaults to +$(SITEPREFIX)/man/man$(MAN*EXT). + +If set to 'none', no man pages will be installed. + +=item INSTALLSITESCRIPT + +Used by 'make install' which copies files from INST_SCRIPT to this +directory if INSTALLDIRS is set to site (default). + +=item INSTALLVENDORARCH + +Used by 'make install', which copies files from INST_ARCHLIB to this +directory if INSTALLDIRS is set to vendor. + +=item INSTALLVENDORBIN + +Used by 'make install', which copies files from INST_BIN to this +directory if INSTALLDIRS is set to vendor. + +=item INSTALLVENDORLIB + +Used by 'make install', which copies files from INST_LIB to this +directory if INSTALLDIRS is set to vendor. + +=item INSTALLVENDORMAN1DIR + +=item INSTALLVENDORMAN3DIR + +These directories get the man pages at 'make install' time if +INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT). + +If set to 'none', no man pages will be installed. + +=item INSTALLVENDORSCRIPT + +Used by 'make install' which copies files from INST_SCRIPT to this +directory if INSTALLDIRS is set to is set to vendor. + =item INST_ARCHLIB Same as INST_LIB for architecture dependent files. @@ -1356,11 +1719,6 @@ Same as INST_LIB for architecture dependent files. Directory to put real binary files during 'make'. These will be copied to INSTALLBIN during 'make install' -=item INST_EXE - -Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you -need to use it. - =item INST_LIB Directory where we put library files of this extension while building @@ -1381,9 +1739,23 @@ Directory, where executable files should be installed during testing. make install will copy the files in INST_SCRIPT to INSTALLSCRIPT. +=item LD + +Program to be used to link libraries for dynamic loading. + +Defaults to $Config{ld}. + +=item LDDLFLAGS + +Any special flags that might need to be passed to ld to create a +shared library suitable for dynamic loading. It is up to the makefile +to use it. (See L) + +Defaults to $Config{lddlflags}. + =item LDFROM -defaults to "$(OBJECT)" and is used in the ld command to specify +Defaults to "$(OBJECT)" and is used in the ld command to specify what files to link/load from (also see dynamic_lib below for how to specify ld flags) @@ -1421,21 +1793,47 @@ you specify a scalar as in MakeMaker will turn it into an array with one element. +=item LICENSE + +The licensing terms of your distribution. Generally its "perl" for the +same license as Perl itself. + +See L for the list of options. + +Defaults to "unknown". + =item LINKTYPE 'static' or 'dynamic' (default unless usedl=undef in config.sh). Should only be used to force static linking (also see linkext below). +=item MAKE + +Variant of make you intend to run the generated Makefile with. This +parameter lets Makefile.PL know what make quirks to account for when +generating the Makefile. + +MakeMaker also honors the MAKE environment variable. This parameter +takes precedent. + +Currently the only significant values are 'dmake' and 'nmake' for Windows +users. + +Defaults to $Config{make}. + =item MAKEAPERL Boolean which tells MakeMaker, that it should include the rules to make a perl. This is handled automatically as a switch by MakeMaker. The user normally does not need it. -=item MAKEFILE +=item MAKEFILE_OLD + +When 'make clean' or similar is run, the $(FIRST_MAKEFILE) will be +backed up at this location. -The name of the Makefile to be produced. +Defaults to $(FIRST_MAKEFILE).old or $(FIRST_MAKEFILE)_old on VMS. =item MAN1PODS @@ -1457,6 +1855,25 @@ C and will be installed during C. If it is intended, that a new perl binary be produced, this variable may hold a name for that binary. Defaults to perl +=item META_ADD + +=item META_MERGE + +A hashrefs of items to add to the F. + +They differ in how they behave if they have the same key as the +default metadata. META_ADD will override the default value with it's +own. META_MERGE will merge its value with the default. + +Unless you want to override the defaults, prefer META_MERGE so as to +get the advantage of any future defaults. + +=item MIN_PERL_VERSION + +The minimum required version of Perl for this distribution. + +Either 5.006001 or 5.6.1 format is acceptable. + =item MYEXTLIB If the extension links to a library that it builds set this to the @@ -1477,14 +1894,24 @@ this boolean variable yourself. =item NOECHO -Defaults to C<@>. By setting it to an empty string you can generate a -Makefile that echos all commands. Mainly used in debugging MakeMaker -itself. +Command so make does not print the literal commands its running. + +By setting it to an empty string you can generate a Makefile that +prints all commands. Mainly used in debugging MakeMaker itself. + +Defaults to C<@>. =item NORECURS Boolean. Attribute to inhibit descending into subdirectories. +=item NO_META + +When true, suppresses the generation and addition to the MANIFEST of +the META.yml module meta-data file during 'make distdir'. + +Defaults to false. + =item NO_VC In general, any generated Makefile checks for the current version of @@ -1563,6 +1990,16 @@ nullifies many advantages of Perl's malloc(), such as better usage of system resources, error detection, memory usage reporting, catchable failure of memory allocations, etc. +=item PERLPREFIX + +Directory under which core modules are to be installed. + +Defaults to $Config{installprefixexp} falling back to +$Config{installprefix}, $Config{prefixexp} or $Config{prefix} should +$Config{installprefixexp} not exist. + +Overridden by PREFIX. + =item PERLRUN Use this instead of $(PERL) when you wish to run perl. It will set up @@ -1591,18 +2028,39 @@ See also L. =item PL_FILES -Ref to hash of files to be processed as perl programs. MakeMaker -will default to any found *.PL file (except Makefile.PL) being keys -and the basename of the file being the value. E.g. +MakeMaker can run programs to generate files for you at build time. +By default any file named *.PL (except Makefile.PL and Build.PL) in +the top level directory will be assumed to be a Perl program and run +passing its own basename in as an argument. For example... + + perl foo.PL foo - {'foobar.PL' => 'foobar'} +This behavior can be overridden by supplying your own set of files to +search. PL_FILES accepts a hash ref, the key being the file to run +and the value is passed in as the first argument when the PL file is run. -The *.PL files are expected to produce output to the target files -themselves. If multiple files can be generated from the same *.PL -file then the value in the hash can be a reference to an array of -target file names. E.g. + PL_FILES => {'bin/foobar.PL' => 'bin/foobar'} + +Would run bin/foobar.PL like this: + + perl bin/foobar.PL bin/foobar + +If multiple files from one program are desired an array ref can be used. + + PL_FILES => {'bin/foobar.PL' => [qw(bin/foobar1 bin/foobar2)]} + +In this case the program will be run multiple times using each target file. + + perl bin/foobar.PL bin/foobar1 + perl bin/foobar.PL bin/foobar2 + +PL files are normally run B pm_to_blib and include INST_LIB and +INST_ARCH in its C<@INC> so the just built modules can be +accessed... unless the PL file is making a module (or anything else in +PM) in which case it is run B pm_to_blib and does not include +INST_LIB and INST_ARCH in its C<@INC>. This apparently odd behavior +is there for backwards compatibility (and its somewhat DWIM). - {'foobar.PL' => ['foobar1','foobar2']} =item PM @@ -1635,7 +2093,7 @@ done. For instance, you would need to say: {'PM_FILTER' => 'grep -v \\"^\\#\\"'} -to remove all the leading coments on the fly during the build. The +to remove all the leading comments on the fly during the build. The extra \\ are necessary, unfortunately, because this variable is interpolated within the context of a Perl program built on the command line, and double quotes are what is used with the -e switch to build that command line. The @@ -1679,37 +2137,50 @@ which should be sensible for your platform. If you specify LIB or any INSTALL* variables they will not be effected by the PREFIX. -=item PREREQ_PM - -Hashref: Names of modules that need to be available to run this -extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the -desired version is the value. If the required version number is 0, we -only check if any version is installed already. - =item PREREQ_FATAL Bool. If this parameter is true, failing to have the required modules -(or the right versions thereof) will be fatal. perl Makefile.PL will die -with the proper message. +(or the right versions thereof) will be fatal. C +will C instead of simply informing the user of the missing dependencies. -Note: see L for a shortcut for stopping tests early if -you are missing dependencies. +It is I rare to have to use C. Its use by module +authors is I and should never be used lightly. +Module installation tools have ways of resolving umet dependencies but +to do that they need a F. Using C breaks this. +That's bad. -Do I use this parameter for simple requirements, which could be resolved -at a later time, e.g. after an unsuccessful B of your module. +The only situation where it is appropriate is when you have +dependencies that are indispensible to actually I a +F. For example, MakeMaker's F needs L. +If its not available it cannot write the F. -It is I rare to have to use C at all! +Note: see L for a shortcut for stopping tests early +if you are missing dependencies and are afraid that users might +use your module with an incomplete environment. + +=item PREREQ_PM + +Hashref: Names of modules that need to be available to run this +extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the +desired version is the value. If the required version number is 0, we +only check if any version is installed already. =item PREREQ_PRINT Bool. If this parameter is true, the prerequisites will be printed to -stdout and MakeMaker will exit. The output format is +stdout and MakeMaker will exit. The output format is an evalable hash +ref. + + $PREREQ_PM = { + 'A::B' => Vers1, + 'C::D' => Vers2, + ... + }; + +If a distribution defines a minimal required perl version, this is +added to the output as an additional line of the form: -$PREREQ_PM = { - 'A::B' => Vers1, - 'C::D' => Vers2, - ... - }; + $MIN_PERL_VERSION = '5.008001'; =item PRINT_PREREQ @@ -1717,6 +2188,31 @@ RedHatism for C. The output format is different, though: perl(A::B)>=Vers1 perl(C::D)>=Vers2 ... +A minimal required perl version, if present, will look like this: + + perl(perl)>=5.008001 + +=item SITEPREFIX + +Like PERLPREFIX, but only for the site install locations. + +Defaults to $Config{siteprefixexp}. Perls prior to 5.6.0 didn't have +an explicit siteprefix in the Config. In those cases +$Config{installprefix} will be used. + +Overridable by PREFIX + +=item SIGN + +When true, perform the generation and addition to the MANIFEST of the +SIGNATURE file in the distdir during 'make distdir', via 'cpansign +-s'. + +Note that you need to install the Module::Signature module to +perform this operation. + +Defaults to false. + =item SKIP Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the @@ -1724,13 +2220,6 @@ Makefile. Caution! Do not use the SKIP attribute for the negligible speedup. It may seriously damage the resulting Makefile. Only use it if you really need it. -=item TEST_LIBS - -The set of -I's necessary to run a "make test". Use as: -$(PERL) $(TEST_LIBS) -e '...' for example. - -The paths will be absolute. - =item TYPEMAPS Ref to array of typemap file names. Use this when the typemaps are @@ -1740,6 +2229,18 @@ precedence. A typemap in the current directory has highest precedence, even if it isn't listed in TYPEMAPS. The default system typemap has lowest precedence. +=item VENDORPREFIX + +Like PERLPREFIX, but only for the vendor install locations. + +Defaults to $Config{vendorprefixexp}. + +Overridable by PREFIX + +=item VERBINST + +If true, make install will be verbose + =item VERSION Your version number for distributing the package. This defaults to @@ -1759,19 +2260,33 @@ will be evaluated with eval() and the value of the named variable B the eval() will be assigned to the VERSION attribute of the MakeMaker object. The following lines will be parsed o.k.: - $VERSION = '1.00'; - *VERSION = \'1.01'; - ( $VERSION ) = '$Revision: 1.23 $ ' =~ /\$Revision:\s+([^\s]+)/; + $VERSION = '1.00'; + *VERSION = \'1.01'; + ($VERSION) = q$Revision$ =~ /(\d+)/g; $FOO::VERSION = '1.10'; *FOO::VERSION = \'1.11'; - our $VERSION = 1.2.3; # new for perl5.6.0 but these will fail: - my $VERSION = '1.01'; - local $VERSION = '1.02'; + # Bad + my $VERSION = '1.01'; + local $VERSION = '1.02'; local $FOO::VERSION = '1.30'; +"Version strings" are incompatible should not be used. + + # Bad + $VERSION = 1.2.3; + $VERSION = v1.2.3; + +L objects are fine. As of MakeMaker 6.35 version.pm will be +automatically loaded, but you must declare the dependency on version.pm. +For compatibility with older MakeMaker you should load on the same line +as $VERSION is declared. + + # All on one line + use version; our $VERSION = qv(1.2.3); + (Putting C or C on the preceding line will work o.k.) The file named in VERSION_FROM is not added as a dependency to @@ -1785,6 +2300,11 @@ would have to do something like See attribute C below. +=item VERSION_SYM + +A sanitized VERSION with . replaced by _. For places where . has +special meaning (some filesystems, RCS labels, etc...) + =item XS Hashref of .xs files. MakeMaker will default this. e.g. @@ -1816,7 +2336,8 @@ to the value of the VERSION attribute. =head2 Additional lowercase attributes can be used to pass parameters to the methods which implement that -part of the Makefile. +part of the Makefile. Parameters are specified as a hash ref but are +passed to the method as a hash. =over 2 @@ -1826,7 +2347,7 @@ part of the Makefile. =item depend - {ANY_TARGET => ANY_DEPENDECY, ...} + {ANY_TARGET => ANY_DEPENDENCY, ...} (ANY_TARGET must not be given a double-colon rule by MakeMaker.) @@ -1863,6 +2384,10 @@ be linked. {ANY_MACRO => ANY_VALUE, ...} +=item postamble + +Anything put here will be passed to MY::postamble() if you have one. + =item realclean {FILES => '$(INST_ARCHAUTODIR)/*.xyz'} @@ -1881,7 +2406,7 @@ be linked. If you cannot achieve the desired Makefile behaviour by specifying attributes you may define private subroutines in the Makefile.PL. -Each subroutines returns the text it wishes to have written to +Each subroutine returns the text it wishes to have written to the Makefile. To override a section of the Makefile you can either say: @@ -1889,8 +2414,8 @@ either say: or you can edit the default by saying something like: - sub MY::c_o { - package MY; # so that "SUPER" works right + package MY; # so that "SUPER" works right + sub c_o { my $inherited = shift->SUPER::c_o(@_); $inherited =~ s/old text/new text/; $inherited; @@ -1903,20 +2428,43 @@ for embedding. If you still need a different solution, try to develop another subroutine that fits your needs and submit the diffs to -F or F as appropriate. +C -For a complete description of all MakeMaker methods see L. +For a complete description of all MakeMaker methods see +L. Here is a simple example of how to add a new target to the generated Makefile: sub MY::postamble { - ' + return <<'MAKE_FRAG'; $(MYEXTLIB): sdbm/Makefile cd sdbm && $(MAKE) all - '; + + MAKE_FRAG } +=head2 The End Of Cargo Cult Programming + +WriteMakefile() now does some basic sanity checks on its parameters to +protect against typos and malformatted values. This means some things +which happened to work in the past will now throw warnings and +possibly produce internal errors. + +Some of the most common mistakes: + +=over 2 + +=item C<< MAN3PODS => ' ' >> + +This is commonly used to suppress the creation of man pages. MAN3PODS +takes a hash ref not a string, but the above worked by accident in old +versions of MakeMaker. + +The correct code is C<< MAN3PODS => { } >>. + +=back + =head2 Hintsfile support @@ -1973,6 +2521,10 @@ Copies all the files that are in the MANIFEST file to a newly created directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory exists, it will be removed first. +Additionally, it will create a META.yml module meta-data file in the +distdir and add this to the distdir's MANIFEST. You can shut this +behavior off with the NO_META flag. + =item make disttest Makes a distdir first, and runs a C, a make, and @@ -1981,7 +2533,7 @@ a make test in that directory. =item make tardist First does a distdir. Then a command $(PREOP) which defaults to a null -command, followed by $(TOUNIX), which defaults to a null command under +command, followed by $(TO_UNIX), which defaults to a null command under UNIX, and will convert files in distribution directory to UNIX format otherwise. Next it runs C on that directory into a tarfile and deletes the directory. Finishes with a command $(POSTOP) which @@ -2037,6 +2589,28 @@ An example: WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" }) + +=head2 Module Meta-Data + +Long plaguing users of MakeMaker based modules has been the problem of +getting basic information about the module out of the sources +I running the F and doing a bunch of messy +heuristics on the resulting F. To this end a simple module +meta-data file has been introduced, F. + +F is a YAML document (see http://www.yaml.org) containing +basic information about the module (name, version, prerequisites...) +in an easy to read format. The format is developed and defined by the +Module::Build developers (see +http://module-build.sourceforge.net/META-spec.html) + +MakeMaker will automatically generate a F file for you and +add it to your F as part of the 'distdir' target (and thus +the 'dist' target). This is intended to seamlessly and rapidly +populate CPAN with module meta-data. If you wish to shut this feature +off, set the C C flag to true. + + =head2 Disabling an extension If some events detected in F imply that there is no way @@ -2044,7 +2618,8 @@ to create the Module, but this is a normal state of things, then you can create a F which does nothing, but succeeds on all the "usual" build targets. To do so, use - ExtUtils::MakeMaker::WriteEmptyMakefile(); + use ExtUtils::MakeMaker qw(WriteEmptyMakefile); + WriteEmptyMakefile(); instead of WriteMakefile(). @@ -2054,9 +2629,33 @@ in a subdirectory of some other distribution, or is listed as a dependency in a CPAN::Bundle, but the functionality is supported by different means on the current architecture). +=head2 Other Handy Functions + +=over 4 + +=item prompt + + my $value = prompt($message); + my $value = prompt($message, $default); + +The C function provides an easy way to request user input +used to write a makefile. It displays the $message as a prompt for +input. If a $default is provided it will be used as a default. The +function returns the $value selected by the user. + +If C detects that it is not running interactively and there +is nothing on STDIN or if the PERL_MM_USE_DEFAULT environment variable +is set to true, the $default will be used without prompting. This +prevents automated processes from blocking on user input. + +If no $default is provided an empty string will be used instead. + +=back + + =head1 ENVIRONMENT -=over 8 +=over 4 =item PERL_MM_OPT @@ -2069,24 +2668,46 @@ is processed before any actual command line arguments are processed. If set to a true value then MakeMaker's prompt function will always return the default without waiting for user input. +=item PERL_CORE + +Same as the PERL_CORE parameter. The parameter overrides this. + =back =head1 SEE ALSO -ExtUtils::MM_Unix, ExtUtils::Manifest ExtUtils::Install, -ExtUtils::Embed +L is a pure-Perl alternative to MakeMaker which does +not rely on make or any other external utility. It is easier to +extend to suit your needs. + +L is a wrapper around MakeMaker which adds features +not normally available. + +L and L are both modules to +help you setup your distribution. =head1 AUTHORS -Andy Dougherty >, Andreas KEnig ->, Tim Bunce >. VMS -support by Charles Bailey >. OS/2 support -by Ilya Zakharevich >. +Andy Dougherty C, Andreas KEnig +C, Tim Bunce C. VMS +support by Charles Bailey C. OS/2 support +by Ilya Zakharevich C. + +Currently maintained by Michael G Schwern C + +Send patches and ideas to C. + +Send bug reports via http://rt.cpan.org/. Please send your +generated Makefile along with your report. + +For more up-to-date information, see L. + +=head1 LICENSE -Currently maintained by Michael G Schwern > +This program is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. -Send patches and ideas to >. +See L -Send bug reports via http://rt.cpan.org/. =cut