X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FExtUtils%2FMakeMaker.pm;h=5068834457fdd3dda97d68c88f248066660dd7ed;hb=53273a086103cdbbf7ebdd5f1a18b2c0777cbc1b;hp=dbd881dee3c3e09f8062443a5b66040dca92bd29;hpb=f582e4890c8c9d8f1af27c006641dda54d419af6;p=p5sagit%2Fp5-mst-13.2.git diff --git a/lib/ExtUtils/MakeMaker.pm b/lib/ExtUtils/MakeMaker.pm index dbd881d..5068834 100644 --- a/lib/ExtUtils/MakeMaker.pm +++ b/lib/ExtUtils/MakeMaker.pm @@ -1,22 +1,21 @@ -BEGIN {require 5.004;} - package ExtUtils::MakeMaker; -$VERSION = "5.92_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.46 $, 10)) =~ s/\s+$//; +BEGIN {require 5.005_03;} + +$VERSION = '6.25'; +($Revision) = q$Revision: 1.147 $ =~ /Revision:\s+(\S+)/; require Exporter; use 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_parent + $Revision $VERSION $Verbose %Config + @Prepend_parent @Parent %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable - @Parent $PACKNAME + $Filename ); use strict; @@ -29,6 +28,10 @@ use strict; my $Is_VMS = $^O eq 'VMS'; my $Is_Win32 = $^O eq 'MSWin32'; +# Our filename for diagnostic and debugging purposes. More reliable +# than %INC (think caseless filesystems) +$Filename = __FILE__; + full_setup(); require ExtUtils::MM; # Things like CPAN assume loading ExtUtils::MakeMaker @@ -44,24 +47,104 @@ sub WriteMakefile { require ExtUtils::MY; my %att = @_; + + _verify_att(\%att); + my $mm = MM->new(\%att); $mm->flush; return $mm; } + +# 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', + PL_FILES => 'hash', + PM => 'hash', + PMLIBDIRS => 'array', + PREREQ_PM => 'hash', + SKIP => 'array', + TYPEMAPS => 'array', + XS => 'hash', + _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 = lc ref $val; + unless( grep $given eq $_, @sigs ) { + my $takes = join " or ", map { $_ ne '' ? "$_ reference" + : "string/number" + } @sigs; + my $has = $given ne '' ? "$given reference" + : "string/number"; + warn "WARNING: $key takes a $takes not a $has.\n". + " Please inform the author.\n"; + } + } +} + sub prompt ($;$) { - my($mess,$def)=@_; - $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe? + 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; @@ -70,9 +153,7 @@ sub prompt ($;$) { print "\n"; } } - else { - print "$def\n"; - } + return (!defined $ans || $ans eq '') ? $def : $ans; } @@ -86,9 +167,11 @@ sub eval_in_subdirs { 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 { @@ -109,22 +192,25 @@ sub eval_in_x { } } + +# 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 + INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR INSTALLDIRS - PREFIX SITEPREFIX VENDORPREFIX + DESTDIR PREFIX + PERLPREFIX SITEPREFIX VENDORPREFIX INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN @@ -134,17 +220,18 @@ sub full_setup { INSTALLSCRIPT PERL_LIB PERL_ARCHLIB SITELIBEXP SITEARCHEXP + INC INCLUDE_EXT 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_CORE + LINKTYPE MAKEAPERL MAKEFILE MAKEFILE_OLD MAN1PODS MAN3PODS MAP_TARGET + 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 POLLUTE PPM_INSTALL_EXEC PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ - SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG + 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 /; @@ -163,16 +250,25 @@ 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 metafile_addtomanifest + signature signature_addtomanifest + dist_basics dist_core distdir dist_test dist_ci install force perldepend makefile staticmake test ppd ); # loses section ordering @@ -180,7 +276,7 @@ sub full_setup { @Overridable = @MM_Sections; push @Overridable, qw[ - dir_target libscan makeaperl needs_linking perm_rw perm_rwx + libscan makeaperl needs_linking perm_rw perm_rwx subdir_x test_via_harness test_via_script init_PERL ]; @@ -205,6 +301,9 @@ sub full_setup { exe_ext full_ar ); + # 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; } @@ -224,11 +323,6 @@ sub full_setup { 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 { @@ -255,14 +349,21 @@ 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)]); + exit 0; } # PRINT_PREREQ is RedHatism. if ("@ARGV" =~ /\bPRINT_PREREQ\b/) { - print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n"; + print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } + sort keys %{$self->{PREREQ_PM}}), "\n"; exit 0; } @@ -280,10 +381,17 @@ sub new { 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} @@ -336,8 +444,14 @@ sub new { my $key; for $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 { @@ -373,7 +487,17 @@ sub new { ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g; - $self->init_main(); + $self->init_main; + $self->init_VERSION; + $self->init_dist; + $self->init_INST; + $self->init_INSTALL; + $self->init_DEST; + $self->init_dirscan; + $self->init_xs; + $self->init_PERL; + $self->init_DIRFILESEP; + $self->init_linker; if (! $self->{PERL_SRC} ) { require VMS::Filespec if $Is_VMS; @@ -400,8 +524,8 @@ END } } - $self->init_dirscan(); $self->init_others(); + $self->init_platform(); $self->init_PERM(); my($argv) = neatvalue(\@ARGV); $argv =~ s/^\[/(/; @@ -422,6 +546,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; @@ -436,6 +562,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; @@ -457,7 +584,7 @@ END 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; } } @@ -469,6 +596,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){ @@ -477,7 +608,7 @@ 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->nicetext($self->$method( %a )); } } @@ -491,14 +622,15 @@ sub WriteEmptyMakefile { 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: $!"; + if (-f $self->{MAKEFILE_OLD}) { + _unlink($self->{MAKEFILE_OLD}) or + warn "unlink $self->{MAKEFILE_OLD}: $!"; + } + if ( -f $self->{MAKEFILE} ) { + _rename($self->{MAKEFILE}, $self->{MAKEFILE_OLD}) or + warn "rename $self->{MAKEFILE} => $self->{MAKEFILE_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: $!"; + open MF, '>'.$self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!"; print MF <<'EOP'; all: @@ -534,7 +666,6 @@ sub parse_args{ my($self, @args) = @_; foreach (@args) { unless (m/(.*?)=(.*)/) { - help(),exit 1 if m/^help$/; ++$Verbose if m/^verb/; next; } @@ -546,7 +677,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' @@ -591,6 +724,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}; @@ -602,7 +736,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}"; @@ -612,11 +750,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 @@ -624,15 +762,20 @@ sub check_hints { } sub _run_hintfile { - our $self; + no strict 'vars'; 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; } } @@ -646,7 +789,10 @@ sub mv_all_methods { # still trying to reduce the list to some reasonable minimum -- # because I want to make it easier for the user. A.K. - no warnings 'redefine'; + 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 @@ -733,18 +879,38 @@ sub flush { close FH; my($finalname) = $self->{MAKEFILE}; - rename("MakeMaker.tmp", $finalname); + _rename("MakeMaker.tmp", $finalname) or + warn "rename MakeMaker.tmp => $finalname: $!"; chmod 0644, $finalname unless $Is_VMS; + 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. @@ -811,7 +977,7 @@ __END__ =head1 NAME -ExtUtils::MakeMaker - create an extension Makefile +ExtUtils::MakeMaker - Create a module Makefile =head1 SYNOPSIS @@ -836,24 +1002,7 @@ 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 :-) @@ -869,7 +1018,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 PREFIX=~ Other interesting targets in the generated Makefile are @@ -882,14 +1031,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 in alphabetical order 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 @@ -897,13 +1049,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 @@ -924,7 +1076,7 @@ INSTALLDIRS according to the following table: INSTALLDIRS set to perl site vendor - PREFIX SITEPREFIX VENDORPREFIX + PERLPREFIX SITEPREFIX VENDORPREFIX INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN @@ -944,6 +1096,15 @@ 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 PREFIX and LIB attribute @@ -1131,8 +1292,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 @@ -1204,6 +1365,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' @@ -1211,8 +1384,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 @@ -1254,11 +1443,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 @@ -1286,7 +1484,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 @@ -1421,9 +1621,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) @@ -1473,9 +1687,12 @@ 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 -The name of the Makefile to be produced. +When 'make clean' or similar is run, the $(FIRST_MAKEFILE) will be +backed up at this location. + +Defaults to $(FIRST_MAKEFILE).old or $(FIRST_MAKEFILE)_old on VMS. =item MAN1PODS @@ -1517,14 +1734,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 @@ -1603,6 +1830,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 @@ -1719,15 +1956,6 @@ which should be sensible for your platform. If you specify LIB or any INSTALL* variables they will not be effected by the PREFIX. -Defaults to $Config{installprefixexp}. - -=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 @@ -1742,10 +1970,18 @@ at a later time, e.g. after an unsuccessful B of your module. It is I rare to have to use C at all! +=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, @@ -1761,9 +1997,23 @@ RedHatism for C. The output format is different, though: =item SITEPREFIX -Like PREFIX, but only for the site install locations. +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 during 'make distdir', via 'cpansign -s'. -Defaults to PREFIX (if set) or $Config{siteprefixexp} +Note that you need to install the Module::Signature module to +perform this operation. + +Defaults to false. =item SKIP @@ -1783,9 +2033,11 @@ typemap has lowest precedence. =item VENDORPREFIX -Like PREFIX, but only for the vendor install locations. +Like PERLPREFIX, but only for the vendor install locations. + +Defaults to $Config{vendorprefixexp}. -Defaults to PREFIX (if set) or $Config{vendorprefixexp} +Overridable by PREFIX =item VERBINST @@ -1812,7 +2064,7 @@ MakeMaker object. The following lines will be parsed o.k.: $VERSION = '1.00'; *VERSION = \'1.01'; - ( $VERSION ) = '$Revision: 1.46 $ ' =~ /\$Revision:\s+([^\s]+)/; + $VERSION = sprintf "%d.%03d", q$Revision: 1.147 $ =~ /(\d+)/g; $FOO::VERSION = '1.10'; *FOO::VERSION = \'1.11'; our $VERSION = 1.2.3; # new for perl5.6.0 @@ -1836,6 +2088,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. @@ -1867,7 +2124,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 @@ -1914,6 +2172,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'} @@ -1954,7 +2216,7 @@ for embedding. If you still need a different solution, try to develop another subroutine that fits your needs and submit the diffs to -F +C For a complete description of all MakeMaker methods see L. @@ -1970,6 +2232,27 @@ Makefile: 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< ' '>> + +This is commonly used to supress 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< { }>>. + +=back + =head2 Hintsfile support @@ -2026,6 +2309,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 and add +this to your MANFIEST. 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 @@ -2090,6 +2377,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 @@ -2107,9 +2416,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 @@ -2131,18 +2464,26 @@ ExtUtils::Embed =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 > +Currently maintained by Michael G Schwern C -Send patches and ideas to >. +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 http://www.makemaker.org. +For more up-to-date information, see L. + +=head1 LICENSE + +This program is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. + +See L + =cut