-package ExtUtils::MakeMaker::TieAtt;
-# this package will go away again, when we don't have modules around
-# anymore that import %att It ties an empty %att and records in which
-# object this %att was tied. FETCH and STORE return/store-to the
-# appropriate value from %$self
+package ExtUtils::MakeMaker;
-# the warndirectuse method warns if somebody calls MM->something. It
-# has nothing to do with the tie'd %att.
+BEGIN {require 5.005_03;}
-$Enough_limit = 5;
+$VERSION = '6.16';
+($Revision) = q$Revision: 1.131 $ =~ /Revision:\s+(\S+)/;
-sub TIEHASH {
- bless { SECRETHASH => $_[1]};
-}
+require Exporter;
+use Config;
+use Carp ();
+use File::Path;
+
+use vars qw(
+ @ISA @EXPORT @EXPORT_OK
+ $Revision $VERSION $Verbose %Config
+ @Prepend_parent @Parent
+ %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable
+ $Filename
+ );
+use strict;
-sub FETCH {
- print "Warning (non-fatal): Importing of %att is deprecated [$_[1]]
- use \$self instead\n" unless ++$Enough>$Enough_limit;
- print "Further ExtUtils::MakeMaker::TieAtt warnings suppressed\n" if $Enough==$Enough_limit;
- $_[0]->{SECRETHASH}->{$_[1]};
-}
+@ISA = qw(Exporter);
+@EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
+@EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists);
-sub STORE {
- print "Warning (non-fatal): Importing of %att is deprecated [$_[1]][$_[2]]
- use \$self instead\n" unless ++$Enough>$Enough_limit;
- print "Further ExtUtils::MakeMaker::TieAtt warnings suppressed\n" if $Enough==$Enough_limit;
- $_[0]->{SECRETHASH}->{$_[1]} = $_[2];
-}
+# These will go away once the last of the Win32 & VMS specific code is
+# purged.
+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
+ # will give them MM.
+
+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 it's own CPAN module.
+
+
+sub WriteMakefile {
+ Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
-sub FIRSTKEY {
- print "Warning (non-fatal): Importing of %att is deprecated [FIRSTKEY]
- use \$self instead\n" unless ++$Enough>$Enough_limit;
- print "Further ExtUtils::MakeMaker::TieAtt warnings suppressed\n" if $Enough==$Enough_limit;
- each %{$_[0]->{SECRETHASH}};
+ 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 NEXTKEY {
- each %{$_[0]->{SECRETHASH}};
+sub prompt ($;$) {
+ 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 : "";
+
+ local $|=1;
+ local $\;
+ print "$mess $dispdef";
+
+ my $ans;
+ if ($ENV{PERL_MM_USE_DEFAULT} || (!$isa_tty && eof STDIN)) {
+ print "$def\n";
+ }
+ else {
+ $ans = <STDIN>;
+ if( defined $ans ) {
+ chomp $ans;
+ }
+ else { # user hit ctrl-D
+ print "\n";
+ }
+ }
+
+ return (!defined $ans || $ans eq '') ? $def : $ans;
}
-sub DESTROY {
+sub eval_in_subdirs {
+ my($self) = @_;
+ use Cwd qw(cwd abs_path);
+ 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);
+ }
+ chdir $pwd;
}
-sub warndirectuse {
- my($caller) = @_;
- return if $Enough>$Enough_limit;
- print STDOUT "Warning (non-fatal): Direct use of class methods deprecated; use\n";
- my($method) = $caller =~ /.*:(\w+)$/;
- print STDOUT
-' my $self = shift;
- $self->MM::', $method, "();
- instead\n";
- print "Further ExtUtils::MakeMaker::TieAtt warnings suppressed\n"
- if ++$Enough==$Enough_limit;
+sub eval_in_x {
+ my($self,$dir) = @_;
+ chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
+
+ {
+ package main;
+ do './Makefile.PL';
+ };
+ if ($@) {
+# if ($@ =~ /prerequisites/) {
+# die "MakeMaker WARNING: $@";
+# } else {
+# warn "WARNING from evaluation of $dir/Makefile.PL: $@";
+# }
+ die "ERROR from evaluation of $dir/Makefile.PL: $@";
+ }
}
-package ExtUtils::MakeMaker;
-# Last edited $Date: 1995/11/12 10:05:55 $ by Andreas Koenig
-# $Id: MakeMaker.pm,v 1.105 1995/11/12 10:05:55 k Exp $
+# package name for the classes into which the first object will be blessed
+my $PACKNAME = 'PACK000';
-$Version = $VERSION = "5.06";
+sub full_setup {
+ $Verbose ||= 0;
-$ExtUtils::MakeMaker::Version_OK = 4.13; # Makefiles older than $Version_OK will die
- # (Will be checked from MakeMaker version 4.13 onwards)
+ my @attrib_help = qw/
-use Config;
-use Carp;
-use Cwd;
-require Exporter;
-require ExtUtils::Manifest;
-require ExtUtils::Liblist;
-#use strict qw(refs);
+ AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
+ C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
+ EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE
+ FULLPERL FULLPERLRUN FULLPERLRUNINST
+ FUNCLIST H IMPORTS
-eval {require DynaLoader;}; # Get mod2fname, if defined. Will fail
- # with miniperl.
+ INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR
+ INSTALLDIRS
+ DESTDIR PREFIX
+ PERLPREFIX SITEPREFIX VENDORPREFIX
+ INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
+ INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
+ INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
+ INSTALLMAN1DIR INSTALLMAN3DIR
+ INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR
+ INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR
+ INSTALLSCRIPT
+ PERL_LIB PERL_ARCHLIB
+ SITELIBEXP SITEARCHEXP
-# print join "**\n**", "", %INC, "";
-%NORMAL_INC = %INC;
+ INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS
+ 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
+ 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
+ /;
+ # IMPORTS is used under OS/2 and Win32
-@ISA = qw(Exporter);
-@EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
-@EXPORT_OK = qw($Version $VERSION &Version_check
- &help &neatvalue &mkbootstrap &mksymlists
- %att ## Import of %att is deprecated, please use OO features!
-);
+ # @Overridable is close to @MM_Sections but not identical. The
+ # order is important. Many subroutines declare macros. These
+ # depend on each other. Let's try to collect the macros up front,
+ # then pasthru, then the rules.
-$Is_VMS = $Config::Config{osname} eq 'VMS';
-require ExtUtils::MM_VMS if $Is_VMS;
-$Is_OS2 = $Config::Config{osname} =~ m|^os/?2$|i ;
-$ENV{EMXSHELL} = 'sh' if $Is_OS2; # to run `commands`
-
-$ExtUtils::MakeMaker::Verbose = 0;
-$^W=1;
-#$SIG{__DIE__} = sub { print @_, Carp::longmess(); die; };
-####$SIG{__WARN__} = sub { print Carp::longmess(); warn @_; };
-$SIG{__WARN__} = sub { $_[0] =~ /^Use of uninitialized value/ && return; };
-
-# Setup dummy package:
-# MY exists for overriding methods to be defined within
-unshift(@MY::ISA, qw(MM));
-
-# Dummy package MM inherits actual methods from OS-specific
-# default packages. We use this intermediate package so
-# MY::XYZ->func() can call MM->func() and get the proper
-# default routine without having to know under what OS
-# it's running.
-
-@MM::ISA = qw[MM_Unix ExtUtils::MakeMaker];
-unshift @MM::ISA, 'ExtUtils::MM_VMS' if $Is_VMS;
-unshift @MM::ISA, 'ExtUtils::MM_OS2' if $Is_OS2;
-
-
-@ExtUtils::MakeMaker::MM_Sections_spec = (
- post_initialize => {},
- const_config => {},
- constants => {},
- const_loadlibs => {},
- const_cccmd => {}, # the last but one addition here (CONST_CCCMD)
- tool_autosplit => {},
- tool_xsubpp => {},
- tools_other => {},
- dist => {},
- macro => {},
- post_constants => {},
- pasthru => {},
- c_o => {},
- xs_c => {},
- xs_o => {},
- top_targets => {}, # currently the last section that adds a key to $self (DIR_TARGET)
- linkext => {},
- dlsyms => {},
- dynamic => {},
- dynamic_bs => {},
- dynamic_lib => {},
- static => {},
- static_lib => {},
- installpm => {},
- manifypods => {},
- processPL => {},
- installbin => {},
- subdirs => {},
- clean => {},
- realclean => {},
- dist_basics => {},
- dist_core => {},
- dist_dir => {},
- dist_test => {},
- dist_ci => {},
- install => {},
- force => {},
- perldepend => {},
- makefile => {},
- staticmake => {}, # Sadly this defines more macros
- test => {},
- postamble => {}, # should always be last the user has hands on
- selfdocument => {}, # well, he may override it, but he won't do it
-);
-# looses section ordering
-%ExtUtils::MakeMaker::MM_Sections = @ExtUtils::MakeMaker::MM_Sections_spec;
-# keeps order
-@ExtUtils::MakeMaker::MM_Sections = grep(!ref, @ExtUtils::MakeMaker::MM_Sections_spec);
-
-%ExtUtils::MakeMaker::Recognized_Att_Keys = %ExtUtils::MakeMaker::MM_Sections; # All sections are valid keys.
-foreach(split(/\n/,attrib_help())){
- next unless m/^=item\s+(\w+)\s*$/;
- $ExtUtils::MakeMaker::Recognized_Att_Keys{$1} = $2;
- print "Attribute '$1' => '$2'\n" if ($ExtUtils::MakeMaker::Verbose >= 2);
-}
+ # MM_Sections are the sections we have to call explicitly
+ # in Overridable we have subroutines that are used indirectly
-%ExtUtils::MakeMaker::Prepend_dot_dot = qw(
-INST_LIB 1 INST_ARCHLIB 1 INST_EXE 1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1
-PERL_SRC 1 PERL 1 FULLPERL 1
-);
-$PACKNAME = "PACK000";
+
+ @MM_Sections =
+ qw(
+
+ 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
+
+ special_targets
+ c_o xs_c xs_o
+ top_targets linkext dlsyms dynamic dynamic_bs
+ dynamic_lib static static_lib manifypods processPL
+ installbin subdirs
+ clean_subdirs clean realclean_subdirs realclean
+ metafile metafile_addtomanifest
+ dist_basics dist_core distdir dist_test dist_ci
+ install force perldepend makefile staticmake test ppd
+
+ ); # loses section ordering
+
+ @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
+ ];
+
+ push @MM_Sections, qw[
+
+ pm_to_blib selfdocument
+
+ ];
+
+ # Postamble needs to be the last that was always the case
+ push @MM_Sections, "postamble";
+ push @Overridable, "postamble";
+
+ # All sections are valid keys.
+ @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
+
+ # 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
+ );
+
+ # 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;
+ }
+ foreach my $item (@Get_from_Config) {
+ $Recognized_Att_Keys{uc $item} = $Config{$item};
+ print "Attribute '\U$item\E' => '$Config{$item}'\n"
+ if ($Verbose >= 2);
+ }
+
+ #
+ # When we eval a Makefile.PL in a subdirectory, that one will ask
+ # us (the parent) for the values and will prepend "..", so that
+ # all files to be installed end up below OUR ./blib
+ #
+ @Prepend_parent = qw(
+ INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT
+ MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC
+ PERL FULLPERL
+ );
+}
sub writeMakefile {
die <<END;
END
}
-sub WriteMakefile {
- Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
- my %att = @_;
- MM->new(\%att)->flush;
-}
-
sub new {
my($class,$self) = @_;
my($key);
- print STDOUT "MakeMaker (v$ExtUtils::MakeMaker::VERSION)\n" if $ExtUtils::MakeMaker::Verbose;
+ # 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";
+ exit 0;
+ }
+
+ print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
if (-f "MANIFEST" && ! -f "Makefile"){
- check_manifest();
+ check_manifest();
}
$self = {} unless (defined $self);
- check_hints();
+ check_hints($self);
+ my %configure_att; # record &{$self->{CONFIGURE}} attributes
my(%initial_att) = %$self; # record initial attributes
+ my(%unsatisfied) = ();
+ foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
+ # 5.8.0 has a bug with require Foo::Bar alone in an eval, so an
+ # extra statement is a workaround.
+ eval "require $prereq; 0";
+
+ 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 ($pr_version < $self->{PREREQ_PM}->{$prereq} ){
+ warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n",
+ $prereq, $self->{PREREQ_PM}{$prereq},
+ ($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 (defined $self->{CONFIGURE}) {
- if (ref $self->{CONFIGURE} eq 'CODE') {
- $self = { %$self, %{&{$self->{CONFIGURE}}}};
- } else {
- croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
- }
+ if (ref $self->{CONFIGURE} eq 'CODE') {
+ %configure_att = %{&{$self->{CONFIGURE}}};
+ $self = { %$self, %configure_att };
+ } else {
+ Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
+ }
}
# This is for old Makefiles written pre 5.00, will go away
if ( Carp::longmess("") =~ /runsubdirpl/s ){
- $self->{Correct_relativ_directories}++;
- } else {
- $self->{Correct_relativ_directories}=0;
+ Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
}
- my $class = ++$PACKNAME;
+ my $newclass = ++$PACKNAME;
+ local @Parent = @Parent; # Protect against non-local exits
{
-# no strict;
- print "Blessing Object into class [$class]\n" if $ExtUtils::MakeMaker::Verbose;
- mv_all_methods("MY",$class);
- bless $self, $class;
-######## tie %::att, ExtUtils::MakeMaker::TieAtt, $self;
- push @ExtUtils::MakeMaker::Parent, $self;
- @{"$class\:\:ISA"} = 'MM';
- }
-
- if (defined $ExtUtils::MakeMaker::Parent[-2]){
- $self->{PARENT} = $ExtUtils::MakeMaker::Parent[-2];
- my $key;
- for $key (keys %ExtUtils::MakeMaker::Prepend_dot_dot) {
- next unless defined $self->{PARENT}{$key};
- $self->{$key} = $self->{PARENT}{$key};
- $self->{$key} = $self->catdir("..",$self->{$key})
- unless $self->{$key} =~ m!^/!;
- }
- $self->{PARENT}->{CHILDREN}->{$class} = $self if $self->{PARENT};
+ 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;
+ @{"$newclass\:\:ISA"} = 'MM';
+ }
+
+ if (defined $Parent[-2]){
+ $self->{PARENT} = $Parent[-2];
+ 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 ($Is_VMS && $key =~ /PERL$/) {
+ $self->{$key} = $self->catdir("..",$self->{$key})
+ unless $self->file_name_is_absolute($self->{$key});
+ } else {
+ # PERL or FULLPERL will be a command verb or even a
+ # command with an argument instead of a full file
+ # specification under VMS. So, don't turn the command
+ # into a filespec, but do add a level to the path of
+ # the argument if not already absolute.
+ my @cmd = split /\s+/, $self->{$key};
+ $cmd[1] = $self->catfile('[-]',$cmd[1])
+ unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]);
+ $self->{$key} = join(' ', @cmd);
+ }
+ }
+ if ($self->{PARENT}) {
+ $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
+ foreach my $opt (qw(POLLUTE PERL_CORE)) {
+ if (exists $self->{PARENT}->{$opt}
+ and not exists $self->{$opt})
+ {
+ # inherit, but only if already unspecified
+ $self->{$opt} = $self->{PARENT}->{$opt};
+ }
+ }
+ }
+ my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
+ parse_args($self,@fm) if @fm;
} else {
- parse_args($self,@ARGV);
+ 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();
-
- if (! $self->{PERL_SRC} &&
- $INC{'Config.pm'} ne $self->catdir($Config::Config{archlibexp},'Config.pm')){
- (my $pthinks = $INC{'Config.pm'}) =~ s!/Config\.pm$!!;
- $pthinks =~ s!.*/!!;
- print STDOUT <<END;
-Your perl and your Config.pm seem to have different ideas about the architecture
-they are running on.
+ $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;
+ my($pthinks) = $self->canonpath($INC{'Config.pm'});
+ my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
+ $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
+ if ($pthinks ne $cthinks &&
+ !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
+ print "Have $pthinks expected $cthinks\n";
+ if ($Is_Win32) {
+ $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
+ }
+ else {
+ $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
+ }
+ print STDOUT <<END unless $self->{UNINSTALLED_PERL};
+Your perl and your Config.pm seem to have different ideas about the
+architecture they are running on.
Perl thinks: [$pthinks]
-Config says: [$Config::Config{archname}]
-This may or may not cause problems. Please check your installation of perl if you
-have problems building this extension.
+Config says: [$Config{archname}]
+This may or may not cause problems. Please check your installation of perl
+if you have problems building this extension.
END
+ }
}
- $self->init_dirscan();
$self->init_others();
+ $self->init_platform();
+ $self->init_PERM();
+ my($argv) = neatvalue(\@ARGV);
+ $argv =~ s/^\[/(/;
+ $argv =~ s/\]$/)/;
push @{$self->{RESULT}}, <<END;
# This Makefile is for the $self->{NAME} extension to perl.
#
-# It was generated automatically by MakeMaker version $ExtUtils::MakeMaker::VERSION from the contents
-# of Makefile.PL. Don't edit this file, edit Makefile.PL instead.
+# It was generated automatically by MakeMaker version
+# $VERSION (Revision: $Revision) from the contents of
+# Makefile.PL. Don't edit this file, edit Makefile.PL instead.
+#
+# ANY CHANGES MADE HERE WILL BE LOST!
#
-# ANY CHANGES MADE HERE WILL BE LOST!
+# MakeMaker ARGV: $argv
#
# MakeMaker Parameters:
END
- foreach $key (sort keys %initial_att){
- my($v) = neatvalue($initial_att{$key});
- $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
- $v =~ tr/\n/ /s;
- push @{$self->{RESULT}}, "# $key => $v";
+ 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;
+ push @{$self->{RESULT}}, "# $key => $v";
+ }
+ undef %initial_att; # free memory
+
+ if (defined $self->{CONFIGURE}) {
+ push @{$self->{RESULT}}, <<END;
+
+# MakeMaker 'CONFIGURE' Parameters:
+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;
+ push @{$self->{RESULT}}, "# $key => $v";
+ }
+ }
+ else
+ {
+ push @{$self->{RESULT}}, "# no values returned";
+ }
+ undef %configure_att; # free memory
}
# turn the SKIP array into a SKIPHASH hash
my (%skip,$skip);
for $skip (@{$self->{SKIP} || []}) {
- $self->{SKIPHASH}{$skip} = 1;
+ $self->{SKIPHASH}{$skip} = 1;
+ }
+ delete $self->{SKIP}; # free memory
+
+ if ($self->{PARENT}) {
+ for (qw/install dist dist_basics dist_core distdir dist_test dist_ci/) {
+ $self->{SKIPHASH}{$_} = 1;
+ }
}
# We run all the subdirectories now. They don't have much to query
# from the parent, but the parent has to query them: if they need linking!
- my($dir);
unless ($self->{NORECURS}) {
- foreach $dir (@{$self->{DIR}}){
- chdir $dir;
- package main;
- local *FH;
- open FH, "Makefile.PL";
- eval join "", <FH>;
- close FH;
- chdir "..";
- }
- }
-
- tie %::att, ExtUtils::MakeMaker::TieAtt, $self;
- my $section;
- foreach $section ( @ExtUtils::MakeMaker::MM_Sections ){
- print "Processing Makefile '$section' section\n" if ($ExtUtils::MakeMaker::Verbose >= 2);
- my($skipit) = $self->skipcheck($section);
- if ($skipit){
- push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
- } else { # MEMO: b 329 print "$self->{NAME}**$section**\n" and $section eq 'postamble'
- my(%a) = %{$self->{$section} || {}};
- push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
- push @{$self->{RESULT}}, "# " . join ", ", %a if $ExtUtils::MakeMaker::Verbose && %a;
- push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
- }
+ $self->eval_in_subdirs if @{$self->{DIR}};
+ }
+
+ 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){
+ push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
+ } else {
+ 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->$method( %a ));
+ }
}
push @{$self->{RESULT}}, "\n# End.";
-######## untie %::att;
- pop @ExtUtils::MakeMaker::Parent;
$self;
}
+sub WriteEmptyMakefile {
+ Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
+
+ my %att = @_;
+ my $self = MM->new(\%att);
+ 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}: $!"
+ }
+ open MF, '>'.$self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
+ print MF <<'EOP';
+all:
+
+clean:
+
+install:
+
+makemakerdflt:
+
+test:
+
+EOP
+ close MF or die "close $self->{MAKEFILE} for write: $!";
+}
+
sub check_manifest {
- eval {require ExtUtils::Manifest};
- if ($@){
- print STDOUT "Warning: you have not installed the ExtUtils::Manifest
- module -- skipping check of the MANIFEST file\n";
+ print STDOUT "Checking if your kit is complete...\n";
+ require ExtUtils::Manifest;
+ # avoid warning
+ $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
+ my(@missed) = ExtUtils::Manifest::manicheck();
+ if (@missed) {
+ print STDOUT "Warning: the following files are missing in your kit:\n";
+ print "\t", join "\n\t", @missed;
+ print STDOUT "\n";
+ print STDOUT "Please inform the author.\n";
} else {
- print STDOUT "Checking if your kit is complete...\n";
- $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
- my(@missed)=ExtUtils::Manifest::manicheck();
- if (@missed){
- print STDOUT "Warning: the following files are missing in your kit:\n";
- print "\t", join "\n\t", @missed;
- print STDOUT "\n";
- print STDOUT "Please inform the author.\n";
- } else {
- print STDOUT "Looks good\n";
- }
+ print STDOUT "Looks good\n";
}
}
sub parse_args{
my($self, @args) = @_;
- foreach (@args){
- unless (m/(.*?)=(.*)/){
- help(),exit 1 if m/^help$/;
- ++$ExtUtils::MakeMaker::Verbose if m/^verb/;
- next;
- }
- my($name, $value) = ($1, $2);
- if ($value =~ m/^~(\w+)?/){ # tilde with optional username
- $value =~ s [^~(\w*)]
- [$1 ?
- ((getpwnam($1))[7] || "~$1") :
- (getpwuid($>))[7]
- ]ex;
- }
- # This may go away, in mid 1996
- if ($self->{Correct_relativ_directories}){
- $value = $self->catdir("..",$value)
- if $ExtUtils::MakeMaker::Prepend_dot_dot{$name} && ! $value =~ m!^/!;
- }
- $self->{$name} = $value;
+ foreach (@args) {
+ unless (m/(.*?)=(.*)/) {
+ help(),exit 1 if m/^help$/;
+ ++$Verbose if m/^verb/;
+ next;
+ }
+ my($name, $value) = ($1, $2);
+ if ($value =~ m/^~(\w+)?/) { # tilde with optional username
+ $value =~ s [^~(\w*)]
+ [$1 ?
+ ((getpwnam($1))[7] || "~$1") :
+ (getpwuid($>))[7]
+ ]ex;
+ }
+
+ # Remember the original args passed it. It will be useful later.
+ $self->{ARGS}{uc $name} = $self->{uc $name} = $value;
}
- # This may go away, in mid 1996
- delete $self->{Correct_relativ_directories};
# catch old-style 'potential_libs' and inform user how to 'upgrade'
if (defined $self->{potential_libs}){
- my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
- if ($self->{potential_libs}){
- print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
- } else {
- print STDOUT "$msg deleted.\n";
- }
- $self->{LIBS} = [$self->{potential_libs}];
- delete $self->{potential_libs};
+ my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
+ if ($self->{potential_libs}){
+ print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
+ } else {
+ print STDOUT "$msg deleted.\n";
+ }
+ $self->{LIBS} = [$self->{potential_libs}];
+ delete $self->{potential_libs};
}
# catch old-style 'ARMAYBE' and inform user how to 'upgrade'
if (defined $self->{ARMAYBE}){
- my($armaybe) = $self->{ARMAYBE};
- print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
- "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
- my(%dl) = %{$self->{dynamic_lib} || {}};
- $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
- delete $self->{ARMAYBE};
+ my($armaybe) = $self->{ARMAYBE};
+ print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
+ "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
+ my(%dl) = %{$self->{dynamic_lib} || {}};
+ $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
+ delete $self->{ARMAYBE};
}
if (defined $self->{LDTARGET}){
- print STDOUT "LDTARGET should be changed to LDFROM\n";
- $self->{LDFROM} = $self->{LDTARGET};
- delete $self->{LDTARGET};
+ print STDOUT "LDTARGET should be changed to LDFROM\n";
+ $self->{LDFROM} = $self->{LDTARGET};
+ delete $self->{LDTARGET};
}
# Turn a DIR argument on the command line into an array
if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
- # So they can choose from the command line, which extensions they want
- # the grep enables them to have some colons too much in case they
- # have to build a list with the shell
- $self->{DIR} = [grep $_, split ":", $self->{DIR}];
+ # So they can choose from the command line, which extensions they want
+ # the grep enables them to have some colons too much in case they
+ # have to build a list with the shell
+ $self->{DIR} = [grep $_, split ":", $self->{DIR}];
+ }
+ # Turn a INCLUDE_EXT argument on the command line into an array
+ if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
+ $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
}
- my $mmkey;
- foreach $mmkey (sort keys %$self){
- print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $ExtUtils::MakeMaker::Verbose;
- print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
- unless exists $ExtUtils::MakeMaker::Recognized_Att_Keys{$mmkey};
+ # Turn a EXCLUDE_EXT argument on the command line into an array
+ if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
+ $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
+ }
+
+ 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};
}
+ $| = 1 if $Verbose;
}
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(@goodhints);
- my($hint)="$Config::Config{osname}_$Config::Config{osvers}";
+ my($hint)="${^O}_$Config{osvers}";
$hint =~ s/\./_/g;
$hint =~ s/_$//;
return unless $hint;
# 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
+ last unless $hint =~ s/_[^_]*$//; # nothing to cut off
+ }
+ my $hint_file = File::Spec->catfile($hint_dir, "$hint.pl");
+
+ return unless -f $hint_file; # really there
+
+ _run_hintfile($self, $hint_file);
+}
+
+sub _run_hintfile {
+ no strict 'vars';
+ local($self) = shift; # make $self available to the hint file.
+ my($hint_file) = shift;
+
+ local($@, $!);
+ print STDERR "Processing hints file $hint_file\n";
+
+ # 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;
}
- return unless -f "hints/$hint.pl"; # really there
-
- # execute the hintsfile:
- local *HINTS;
- open HINTS, "hints/$hint.pl";
- @goodhints = <HINTS>;
- close HINTS;
- print STDOUT "Processing hints file hints/$hint.pl\n";
- eval join('',@goodhints);
- print STDOUT $@ if $@;
}
sub mv_all_methods {
my($from,$to) = @_;
- my($method);
-# no strict;
+ no strict 'refs';
+ my($symtab) = \%{"${from}::"};
- foreach $method (@ExtUtils::MakeMaker::MM_Sections, qw[ dir_target exescan
-fileparse fileparse_set_fstype init_dirscan init_main init_others
-installpm_x libscan makeaperl mksymlists needs_linking runsubdirpl
-subdir_x test_via_harness test_via_script writedoc ]) {
+ # 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.
- # We cannot say "next" here. Nick might call MY->makeaperl
- # which isn't defined right now
+ 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
+ # which isn't defined right now
- # next unless defined &{"${from}::$method"};
+ # Above statement was written at 4.23 time when Tk-b8 was
+ # around. As Tk-b9 only builds with 5.002something and MM 5 is
+ # standard, we try to enable the next line again. It was
+ # commented out until MM 5.23
- *{"${to}::$method"} = \&{"${from}::$method"};
- my $symtab = \%{"${from}::"};
+ next unless defined &{"${from}::$method"};
- # delete would do, if we were sure, nobody ever called
- # MY->makeaperl directly
+ *{"${to}::$method"} = \&{"${from}::$method"};
- # delete $symtab->{$method};
+ # delete would do, if we were sure, nobody ever called
+ # MY->makeaperl directly
- # 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:
+ # delete $symtab->{$method};
- eval "package MY; sub $method {local *$method; shift->MY::$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(\@_); }";
+ }
# We have to clean out %INC also, because the current directory is
# changed frequently and Graham Barr prefers to get his version
# out of a History.pl file which is "required" so woudn't get
# loaded again in another extension requiring a History.pl
- my $inc;
- foreach $inc (keys %INC) {
- next if $ExtUtils::MakeMaker::NORMAL_INC{$inc};
- #warn "***$inc*** deleted";
- delete $INC{$inc};
- }
-
-}
-
-sub prompt {
- my($mess,$def)=@_;
- BEGIN { my $ISA_TTY = -t STDIN && -t STDOUT }
- Carp::confess("prompt function called without an argument") unless defined $mess;
- $def = "" unless defined $def;
- my $dispdef = "[$def] ";
- my $ans;
- if ($ISA_TTY) {
- local $|=1;
- print "$mess $dispdef";
- chop($ans = <STDIN>);
- }
- return $ans if defined $ans;
- return $def;
-}
-
-sub attrib_help {
- return $Attrib_Help if $Attrib_Help;
- my $switch = 0;
- my $help;
- my $line;
- local *POD;
-#### local $/ = ""; # bug in 5.001m
- open POD, $INC{"ExtUtils/MakeMaker.pm"}
- or die "Open $INC{'ExtUtils/MakeMaker.pm'}: $!";
- while ($line = <POD>) {
- $switch ||= $line =~ /^=item NAME\s*$/;
- next unless $switch;
- last if $line =~ /^=cut/;
- $help .= $line;
- }
- close POD;
- $Attrib_Help = $help;
+ # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
+ # to core dump in the middle of a require statement. The required
+ # file was Tk/MMutil.pm. The consequence is, we have to be
+ # extremely careful when we try to give perl a reason to reload a
+ # library with same name. The workaround prefers to drop nothing
+ # from %INC and teach the writers not to use such libraries.
+
+# my $inc;
+# foreach $inc (keys %INC) {
+# #warn "***$inc*** deleted";
+# delete $INC{$inc};
+# }
}
-sub help {print &attrib_help, "\n";}
-
-sub skipcheck{
+sub skipcheck {
my($self) = shift;
my($section) = @_;
if ($section eq 'dynamic') {
- print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
- "in skipped section 'dynamic_bs'\n"
- if $self->{SKIPHASH}{dynamic_bs} && $ExtUtils::MakeMaker::Verbose;
print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
- "in skipped section 'dynamic_lib'\n"
- if $self->{SKIPHASH}{dynamic_lib} && $ExtUtils::MakeMaker::Verbose;
+ "in skipped section 'dynamic_bs'\n"
+ if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
+ print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
+ "in skipped section 'dynamic_lib'\n"
+ if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
}
if ($section eq 'dynamic_lib') {
print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
- "targets in skipped section 'dynamic_bs'\n"
- if $self->{SKIPHASH}{dynamic_bs} && $ExtUtils::MakeMaker::Verbose;
+ "targets in skipped section 'dynamic_bs'\n"
+ if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
}
if ($section eq 'static') {
print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
- "in skipped section 'static_lib'\n"
- if $self->{SKIPHASH}{static_lib} && $ExtUtils::MakeMaker::Verbose;
+ "in skipped section 'static_lib'\n"
+ if $self->{SKIPHASH}{static_lib} && $Verbose;
}
return 'skipped' if $self->{SKIPHASH}{$section};
return '';
sub flush {
my $self = shift;
my($chunk);
- local *MAKE;
+ local *FH;
print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
- open MAKE, ">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 MAKE "$chunk\n";
+ print FH "$chunk\n";
+ }
+
+ close FH;
+ my($finalname) = $self->{MAKEFILE};
+ _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{$_};
+ }
}
- close MAKE;
- my($finalname) = $Is_VMS ? "Descrip.MMS" : $self->{MAKEFILE};
- rename("MakeMaker.tmp", $finalname);
- chmod 0644, $finalname;
system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
}
-sub Version_check {
- my($checkversion) = @_;
- die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
-Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
-changes in the meantime.
-Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
- if $checkversion < $ExtUtils::MakeMaker::Version_OK;
- printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
- $checkversion, "Current Version is", $ExtUtils::MakeMaker::VERSION
- unless $checkversion == $ExtUtils::MakeMaker::VERSION;
+
+# 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;
}
-sub mksymlists {
- my $class = shift;
- my $self = shift;
- bless $self, $class;
- tie %att, ExtUtils::MakeMaker::TieAtt, $self;
- $self->parse_args(@ARGV);
- $self->mksymlists(@_);
+# 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.
END
}
+# Ditto for mksymlists() as of MakeMaker 5.17
+sub mksymlists {
+ die <<END;
+!!! Your Makefile has been built such a long time ago, !!!
+!!! that is unlikely to work with current MakeMaker. !!!
+!!! Please rebuild your Makefile !!!
+END
+}
+
sub neatvalue {
my($v) = @_;
return "undef" unless defined $v;
my($t) = ref $v;
- return "'$v'" unless $t;
+ return "q[$v]" unless $t;
if ($t eq 'ARRAY') {
- my(@m, $elem, @neat);
- push @m, "[";
- foreach $elem (@$v) {
- push @neat, "'$elem'";
- }
- push @m, join ", ", @neat;
- push @m, "]";
- return join "", @m;
+ my(@m, @neat);
+ push @m, "[";
+ foreach my $elem (@$v) {
+ push @neat, "q[$elem]";
+ }
+ push @m, join ", ", @neat;
+ push @m, "]";
+ return join "", @m;
}
return "$v" unless $t eq 'HASH';
my(@m, $key, $val);
- push(@m,"$key=>".neatvalue($val)) while (($key,$val) = each %$v);
+ while (($key,$val) = each %$v){
+ last unless defined $key; # cautious programming in case (undef,undef) is true
+ push(@m,"$key=>".neatvalue($val)) ;
+ }
return "{ ".join(', ',@m)." }";
}
sub selfdocument {
my($self) = @_;
my(@m);
- if ($ExtUtils::MakeMaker::Verbose){
- push @m, "\n# Full list of MakeMaker attribute values:";
- foreach $key (sort keys %$self){
- next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
- my($v) = neatvalue($self->{$key});
- $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
- $v =~ tr/\n/ /s;
- push @m, "# $key => $v";
- }
+ if ($Verbose){
+ push @m, "\n# Full list of MakeMaker attribute values:";
+ foreach my $key (sort keys %$self){
+ next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
+ my($v) = neatvalue($self->{$key});
+ $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
+ $v =~ tr/\n/ /s;
+ push @m, "# $key => $v";
+ }
}
join "\n", @m;
}
+1;
- # # # # # #
- ## ## ## ## # # # # # # #
- # # # # # # # # # # ## # # # #
- # # # # # # # # # # # # ##
- # # # # # # # # # # ##
- # # # # # # # ## # # #
- # # # # ####### ##### # # # # #
+__END__
-package MM_Unix;
+=head1 NAME
-use Config;
-use Cwd;
-use File::Basename;
-require Exporter;
+ExtUtils::MakeMaker - Create a module Makefile
-Exporter::import('ExtUtils::MakeMaker',
- qw( $Verbose));
+=head1 SYNOPSIS
-# These attributes cannot be overridden externally
-@Other_Att_Keys{qw(EXTRALIBS BSLOADLIBS LDLOADLIBS)} = (1) x 3;
+ use ExtUtils::MakeMaker;
-if ($Is_VMS = $Config::Config{osname} eq 'VMS') {
- require VMS::Filespec;
- import VMS::Filespec 'vmsify';
-}
+ WriteMakefile( ATTRIBUTE => VALUE [, ...] );
-$Is_OS2 = $ExtUtils::MakeMaker::Is_OS2;
+=head1 DESCRIPTION
-sub guess_name { # Charles! That's something for MM_VMS
- my($self) = @_;
- my $name = fastcwd();
- if ($Is_VMS) {
- $name =~ s:.*?([^.\]]+)\]:$1: unless ($name =~ s:.*[.\[]ext\.(.*)\]:$1:i);
- $name =~ s#[.\]]#::#g;
- } else {
- $name =~ s:.*/:: unless ($name =~ s:^.*/ext/::);
- $name =~ s#/#::#g;
- $name =~ s#\-\d+\.\d+$##; # this is new with MM 5.00
- }
- $name;
-}
+This utility is designed to write a Makefile for an extension module
+from a Makefile.PL. It is based on the Makefile.SH model provided by
+Andy Dougherty and the perl5-porters.
-sub init_main {
- my($self) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
+It splits the task of generating the Makefile into several subroutines
+that can be individually overridden. Each subroutine returns the text
+it wishes to have written to the Makefile.
- # --- Initialize Module Name and Paths
+MakeMaker is object oriented. Each directory below the current
+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().
- # NAME = The perl module name for this extension (eg DBD::Oracle).
- # FULLEXT = Pathname for extension directory (eg DBD/Oracle).
- # BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT.
- # ROOTEXT = Directory part of FULLEXT with leading /.
- ($self->{FULLEXT} =
- $self->{NAME}) =~ s!::!/!g ; #eg. BSD/Foo/Socket
+=head2 How To Write A Makefile.PL
- # Copied from DynaLoader:
+See ExtUtils::MakeMaker::Tutorial.
- my(@modparts) = split(/::/,$self->{NAME});
- my($modfname) = $modparts[-1];
+The long answer is the rest of the manpage :-)
- # Some systems have restrictions on files names for DLL's etc.
- # mod2fname returns appropriate file base name (typically truncated)
- # It may also edit @modparts if required.
- if (defined &DynaLoader::mod2fname) {
- $modfname = &DynaLoader::mod2fname(\@modparts);
- } elsif ($Is_OS2) { # Need manual correction if run with miniperl:-(
- $modfname = substr($modfname, 0, 7) . '_';
- }
+=head2 Default Makefile Behaviour
+The generated Makefile enables the user of the extension to invoke
- ($self->{BASEEXT} =
- $self->{NAME}) =~ s!.*::!! ; #eg. Socket
+ perl Makefile.PL # optionally "perl Makefile.PL verbose"
+ make
+ make test # optionally set TEST_VERBOSE=1
+ make install # See below
- if (defined &DynaLoader::mod2fname or $Is_OS2) {
- # As of 5.001m, dl_os2 appends '_'
- $self->{DLBASE} = $modfname; #eg. Socket_
- } else {
- $self->{DLBASE} = '$(BASEEXT)';
- }
+The Makefile to be produced may be altered by adding arguments of the
+form C<KEY=VALUE>. E.g.
- ($self->{ROOTEXT} =
- $self->{FULLEXT}) =~ s#/?\Q$self->{BASEEXT}\E$## ; #eg. /BSD/Foo
+ perl Makefile.PL PREFIX=/tmp/myperl5
- $self->{ROOTEXT} = ($Is_VMS ? '' : '/') . $self->{ROOTEXT} if $self->{ROOTEXT};
+Other interesting targets in the generated Makefile are
+ make config # to check if the Makefile is up-to-date
+ make clean # delete local temp files (Makefile gets renamed)
+ make realclean # delete derived files (including ./blib)
+ make ci # check in all the files in the MANIFEST file
+ make dist # see below the Distribution Support section
- # --- Initialize PERL_LIB, INST_LIB, PERL_SRC
+=head2 make test
- # *Real* information: where did we get these two from? ...
- my $inc_config_dir = dirname($INC{'Config.pm'});
- my $inc_carp_dir = dirname($INC{'Carp.pm'});
+MakeMaker checks for the existence of a file named F<test.pl> in the
+current directory and if it exists it execute the script with the
+proper set of perl C<-I> options.
- # Typically PERL_* and INST_* will be identical but that need
- # not be the case (e.g., installing into project libraries etc).
+MakeMaker also checks for any files matching glob("t/*.t"). It will
+execute all matching files in alphabetical order via the
+L<Test::Harness> module with the C<-I> switches set correctly.
- # Perl Macro: With source No source
- # PERL_SRC ../.. (undefined)
- # PERL_LIB PERL_SRC/lib /usr/local/lib/perl5
- # PERL_ARCHLIB PERL_SRC/lib /usr/local/lib/perl5/sun4-sunos
+If you'd like to see the raw output of your tests, set the
+C<TEST_VERBOSE> variable to true.
- # INST Macro: For standard for any other
- # modules module
- # INST_LIB PERL_SRC/lib ./blib
- # INST_ARCHLIB PERL_SRC/lib ./blib/<archname>
+ make test TEST_VERBOSE=1
- unless ($self->{PERL_SRC}){
- my($dir);
- foreach $dir (qw(.. ../.. ../../..)){
- if ( -f "$dir/config.sh"
- && -f "$dir/perl.h"
- && -f "$dir/lib/Exporter.pm") {
- $self->{PERL_SRC}=$dir ;
- last;
- }
- }
- }
- if ($self->{PERL_SRC}){
- $self->{PERL_LIB} ||= $self->catdir("$self->{PERL_SRC}","lib");
- $self->{PERL_ARCHLIB} = $self->{PERL_LIB};
- $self->{PERL_INC} = $self->{PERL_SRC};
- # catch an situation that has occurred a few times in the past:
- warn <<EOM unless -s "$self->{PERL_SRC}/cflags";
-You cannot build extensions below the perl source tree after executing
-a 'make clean' in the perl source tree.
-
-To rebuild extensions distributed with the perl source you should
-simply Configure (to include those extensions) and then build perl as
-normal. After installing perl the source tree can be deleted. It is not
-needed for building extensions.
-
-It is recommended that you unpack and build additional extensions away
-from the perl source tree.
-EOM
- } else {
- # we should also consider $ENV{PERL5LIB} here
- $self->{PERL_LIB} = $Config::Config{privlibexp} unless $self->{PERL_LIB};
- $self->{PERL_ARCHLIB} = $Config::Config{archlibexp} unless $self->{PERL_ARCHLIB};
- $self->{PERL_INC} = $self->catdir("$self->{PERL_ARCHLIB}","CORE"); # wild guess for now
- my $perl_h;
- die <<EOM unless (-f ($perl_h = $self->catfile("$self->{PERL_INC}","perl.h")));
-Error: Unable to locate installed Perl libraries or Perl source code.
+=head2 make testdb
-It is recommended that you install perl in a standard location before
-building extensions. You can say:
+A useful variation of the above is the target C<testdb>. It runs the
+test under the Perl debugger (see L<perldebug>). If the file
+F<test.pl> exists in the current directory, it is used for the test.
- $^X Makefile.PL PERL_SRC=/path/to/perl/source/directory
+If you want to debug some other testfile, set the C<TEST_FILE> variable
+thusly:
-if you have not yet installed perl but still want to build this
-extension now.
-(You get this message, because MakeMaker could not find "$perl_h")
-EOM
+ make testdb TEST_FILE=t/mytest.t
-# print STDOUT "Using header files found in $self->{PERL_INC}\n"
-# if $Verbose && $self->needs_linking();
+By default the debugger is called using C<-d> option to perl. If you
+want to specify some other option, set the C<TESTDB_SW> variable:
- }
+ make testdb TESTDB_SW=-Dx
- # INST_LIB typically pre-set if building an extension after
- # perl has been built and installed. Setting INST_LIB allows
- # you to build directly into, say $Config::Config{privlibexp}.
- unless ($self->{INST_LIB}){
+=head2 make install
+make alone puts all relevant files into directories that are named by
+the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
+INST_MAN3DIR. All these default to something below ./blib if you are
+I<not> building below the perl source directory. If you I<are>
+building below the perl source, INST_LIB and INST_ARCHLIB default to
+../../lib, and INST_SCRIPT is not defined.
- ##### XXXXX We have to change this nonsense
+The I<install> target of the generated Makefile copies the files found
+below each of the INST_* directories to their INSTALL*
+counterparts. Which counterparts are chosen depends on the setting of
+INSTALLDIRS according to the following table:
- if (defined $self->{PERL_SRC}) {
- $self->{INST_LIB} = $self->{PERL_LIB};
- } else {
- $self->{INST_LIB} = $self->catdir(".","blib");
- }
- }
- # Try to work out what INST_ARCHLIB should be if not set:
- unless ($self->{INST_ARCHLIB}){
- my(%archmap) = (
- $self->catdir(".","blib") => $self->catdir(".","blib",$Config::Config{archname}), # our private build lib
- $self->{PERL_LIB} => $self->{PERL_ARCHLIB},
- $Config::Config{privlibexp} => $Config::Config{archlibexp},
- $inc_carp_dir => $inc_config_dir,
- );
- $self->{INST_ARCHLIB} = $archmap{$self->{INST_LIB}};
- unless($self->{INST_ARCHLIB}){
- # Oh dear, we'll have to default it and warn the user
- my($archname) = $Config::Config{archname};
- if (-d "$self->{INST_LIB}/$archname"){
- $self->{INST_ARCHLIB} = $self->catdir("$self->{INST_LIB}","$archname");
- print STDOUT "Defaulting INST_ARCHLIB to $self->{INST_ARCHLIB}\n";
- } else {
- $self->{INST_ARCHLIB} = $self->{INST_LIB};
- }
- }
- }
- $self->{INST_EXE} ||= $self->catdir('.','blib',$Config::Config{archname});
+ INSTALLDIRS set to
+ perl site vendor
- if ($self->{PREFIX}){
- $self->{INSTALLPRIVLIB} = $self->catdir($self->{PREFIX},"lib","perl5");
- $self->{INSTALLBIN} = $self->catdir($self->{PREFIX},"bin");
- $self->{INSTALLMAN3DIR} = $self->catdir($self->{PREFIX},"perl5","man","man3")
- unless defined $self->{INSTALLMAN3DIR};
- }
+ PERLPREFIX SITEPREFIX VENDORPREFIX
+ INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
+ INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
+ INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
+ INST_SCRIPT INSTALLSCRIPT INSTALLSCRIPT INSTALLSCRIPT
+ INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR
+ INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR
- if( $self->{INSTALLPRIVLIB} && ! $self->{INSTALLARCHLIB} ){
- my($archname) = $Config::Config{archname};
- if (-d $self->catdir($self->{INSTALLPRIVLIB},$archname)){
- $self->{INSTALLARCHLIB} = $self->catdir($self->{INSTALLPRIVLIB},$archname);
- print STDOUT "Defaulting INSTALLARCHLIB to $self->{INSTALLARCHLIB}\n";
- } else {
- $self->{INSTALLARCHLIB} = $self->{INSTALLPRIVLIB};
- }
- }
- $self->{INSTALLPRIVLIB} ||= $Config::Config{installprivlib};
- $self->{INSTALLARCHLIB} ||= $Config::Config{installarchlib};
- $self->{INSTALLBIN} ||= $Config::Config{installbin};
-
- $self->{INSTALLMAN1DIR} = $Config::Config{installman1dir}
- unless defined $self->{INSTALLMAN1DIR};
- unless (defined $self->{INST_MAN1DIR}){
- if ($self->{INSTALLMAN1DIR} =~ /^(none|\s*)$/){
- $self->{INST_MAN1DIR} = $self->{INSTALLMAN1DIR};
- } else {
- $self->{INST_MAN1DIR} = $self->catdir('.','blib','man','man1');
- }
- }
- $self->{MAN1EXT} ||= $Config::Config{man1ext};
-
- $self->{INSTALLMAN3DIR} = $Config::Config{installman3dir}
- unless defined $self->{INSTALLMAN3DIR};
- unless (defined $self->{INST_MAN3DIR}){
- if ($self->{INSTALLMAN3DIR} =~ /^(none|\s*)$/){
- $self->{INST_MAN3DIR} = $self->{INSTALLMAN3DIR};
- } else {
- $self->{INST_MAN3DIR} = $self->catdir('.','blib','man','man3');
- }
- }
- $self->{MAN3EXT} ||= $Config::Config{man3ext};
+The INSTALL... macros in turn default to their %Config
+($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
- $self->{MAP_TARGET} = "perl" unless $self->{MAP_TARGET};
+You can check the values of these variables on your system with
- $self->{LIB_EXT} = $Config::Config{lib_ext} || ".a";
- $self->{OBJ_EXT} = $Config::Config{obj_ext} || ".o";
- $self->{AR} = $Config::Config{ar} || "ar";
+ perl '-V:install.*'
- unless ($self->{LIBPERL_A}){
- if ($Is_VMS) {
- $self->{LIBPERL_A} = 'libperl.olb';
- } else {
- $self->{LIBPERL_A} = "libperl$self->{LIB_EXT}";
- }
- }
+And to check the sequence in which the library directories are
+searched by perl, run
- # make a few simple checks
- warn "Warning: PERL_LIB ($self->{PERL_LIB}) seems not to be a perl library directory
- (Exporter.pm not found)"
- unless (-f $self->catfile("$self->{PERL_LIB}","Exporter.pm"));
+ perl -le 'print join $/, @INC'
- ($self->{DISTNAME}=$self->{NAME}) =~ s#(::)#-#g unless $self->{DISTNAME};
- $self->{VERSION} = "0.10" unless $self->{VERSION};
- ($self->{VERSION_SYM} = $self->{VERSION}) =~ s/\W/_/g;
+=head2 PREFIX and LIB attribute
- # --- Initialize Perl Binary Locations
+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
- # Find Perl 5. The only contract here is that both 'PERL' and 'FULLPERL'
- # will be working versions of perl 5. miniperl has priority over perl
- # for PERL to ensure that $(PERL) is usable while building ./ext/*
- my $path_sep = $Is_OS2 ? ";" : $Is_VMS ? "/" : ":";
- my $path = $ENV{PATH};
- $path =~ s:\\:/:g if $Is_OS2;
- my @path = split $path_sep, $path;
- my ($component,@defpath);
- foreach $component ($self->{PERL_SRC}, @path, $Config::Config{binexp}) {
- push @defpath, $component if defined $component;
- }
- $self->{PERL} =
- $self->find_perl(5.0, [ $^X, 'miniperl','perl','perl5',"perl$]" ],
- \@defpath, $ExtUtils::MakeMaker::Verbose ) unless ($self->{PERL});
-# don't check, if perl is executable, maybe they
-# have decided to supply switches with perl
-
- # Define 'FULLPERL' to be a non-miniperl (used in test: target)
- ($self->{FULLPERL} = $self->{PERL}) =~ s/miniperl/perl/i
- unless ($self->{FULLPERL});
-}
+ perl Makefile.PL PREFIX=~
-sub init_dirscan { # --- File and Directory Lists (.xs .pm .pod etc)
- my($self) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my($name, %dir, %xs, %c, %h, %ignore, %pl_files, %manifypods);
- local(%pm); #the sub in find() has to see this hash
- $ignore{'test.pl'} = 1;
- $ignore{'makefile.pl'} = 1 if $Is_VMS;
- foreach $name ($self->lsdir(".")){
- next if ($name =~ /^\./ or $ignore{$name});
- if (-d $name){
- $dir{$name} = $name if (-f "$name/Makefile.PL");
- } elsif ($name =~ /\.xs$/){
- my($c); ($c = $name) =~ s/\.xs$/.c/;
- $xs{$name} = $c;
- $c{$c} = 1;
- } elsif ($name =~ /\.c$/){
- $c{$name} = 1
- unless $name =~ m/perlmain\.c/; # See MAP_TARGET
- } elsif ($name =~ /\.h$/){
- $h{$name} = 1;
- } elsif ($name =~ /\.(p[ml]|pod)$/){
- $pm{$name} = $self->catfile('$(INST_LIBDIR)',"$name");
- } elsif ($name =~ /\.PL$/ && $name ne "Makefile.PL") {
- ($pl_files{$name} = $name) =~ s/\.PL$// ;
- }
- }
+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).
- # Some larger extensions often wish to install a number of *.pm/pl
- # files into the library in various locations.
+Another way to specify many INSTALL directories with a single
+parameter is LIB.
- # The attribute PMLIBDIRS holds an array reference which lists
- # subdirectories which we should search for library files to
- # install. PMLIBDIRS defaults to [ 'lib', $self->{BASEEXT} ].
- # We recursively search through the named directories (skipping
- # any which don't exist or contain Makefile.PL files).
+ perl Makefile.PL LIB=~/lib
- # For each *.pm or *.pl file found $self->libscan() is called with
- # the default installation path in $_[1]. The return value of
- # libscan defines the actual installation location. The default
- # libscan function simply returns the path. The file is skipped
- # if libscan returns false.
+This will install the module's architecture-independent files into
+~/lib, the architecture-dependent files into ~/lib/$archname.
- # The default installation location passed to libscan in $_[1] is:
- #
- # ./*.pm => $(INST_LIBDIR)/*.pm
- # ./xyz/... => $(INST_LIBDIR)/xyz/...
- # ./lib/... => $(INST_LIB)/...
- #
- # In this way the 'lib' directory is seen as the root of the actual
- # perl library whereas the others are relative to INST_LIBDIR
- # (which includes ROOTEXT). This is a subtle distinction but one
- # that's important for nested modules.
-
- $self->{PMLIBDIRS} = [ 'lib', $self->{BASEEXT} ] unless $self->{PMLIBDIRS};
-
- #only existing directories that aren't in $dir are allowed
-
- # Avoid $_ wherever possible:
- # @{$self->{PMLIBDIRS}} = grep -d && !$dir{$_}, @{$self->{PMLIBDIRS}};
- my (@pmlibdirs) = @{$self->{PMLIBDIRS}};
- my ($pmlibdir);
- @{$self->{PMLIBDIRS}} = ();
- foreach $pmlibdir (@pmlibdirs) {
- -d $pmlibdir && !$dir{$pmlibdir} && push @{$self->{PMLIBDIRS}}, $pmlibdir;
- }
+Note, that in both cases the tilde expansion is done by MakeMaker, not
+by perl by default, nor by make.
- if (@{$self->{PMLIBDIRS}}){
- print "Searching PMLIBDIRS: @{$self->{PMLIBDIRS}}\n"
- if ($ExtUtils::MakeMaker::Verbose >= 2);
- use File::Find; # try changing to require !
- File::Find::find(sub {
- if (-d $_){
- if ($_ eq "CVS" || $_ eq "RCS"){
- $File::Find::prune = 1;
- }
- return;
- }
- my($path, $prefix) = ($File::Find::name, '$(INST_LIBDIR)');
- my $striplibpath;
- $prefix = '$(INST_LIB)' if (($striplibpath = $path) =~ s:^lib/::);
- my($inst) = $self->catdir($prefix,$striplibpath);
- local($_) = $inst; # for backwards compatibility
- $inst = $self->libscan($inst);
- print "libscan($path) => '$inst'\n" if ($ExtUtils::MakeMaker::Verbose >= 2);
- return unless $inst;
- $pm{$path} = $inst;
- }, @{$self->{PMLIBDIRS}});
- }
+Conflicts between parameters LIB, PREFIX and the various INSTALL*
+arguments are resolved so that:
- $self->{DIR} = [sort keys %dir] unless $self->{DIR};
- $self->{XS} = \%xs unless $self->{XS};
- $self->{PM} = \%pm unless $self->{PM};
- $self->{C} = [sort keys %c] unless $self->{C};
- my(@o_files) = @{$self->{C}};
- $self->{O_FILES} = [grep s/\.c$/$self->{OBJ_EXT}/, @o_files] ;
- $self->{H} = [sort keys %h] unless $self->{H};
- $self->{PL_FILES} = \%pl_files unless $self->{PL_FILES};
-
- # Set up names of manual pages to generate from pods
- # Configure overrides anything else
- if ($self->{MANPODS}) {
- } elsif ( $self->{INST_MAN3DIR} =~ /^(none|\s*)$/ ) {
- $self->{MANPODS} = {};
- } else {
- my %manifypods = (); # we collect the keys first, i.e. the files
- # we have to convert to pod
- foreach $name (keys %{$self->{PM}}) {
- if ($name =~ /\.pod$/ ) {
- $manifypods{$name} = $self->{PM}{$name};
- } elsif ($name =~ /\.p[ml]$/ ) {
- local(*TESTPOD);
- my($ispod)=0;
- open(TESTPOD,"<$name");
- my $testpodline;
- while ($testpodline = <TESTPOD>) {
- if($testpodline =~ /^=head/) {
- $ispod=1;
- last;
- }
- #Speculation on the future (K.A., not A.K. :)
- #if(/^=don't\S+install/) { $ispod=0; last}
- }
- close(TESTPOD);
-
- if( $ispod ) {
- $manifypods{$name} = $self->{PM}{$name};
- }
- }
- }
-
- # Remove "Configure.pm" and similar, if it's not the only pod listed
- # To force inclusion, just name it "Configure.pod", or override MANPODS
- foreach $name (keys %manifypods) {
- if ($name =~ /(config|install|setup).*\.pm/i) {
- delete $manifypods{$name};
- next;
- }
- my($manpagename) = $name;
- unless ($manpagename =~ s!^lib/!!) {
- $manpagename = join("/",$self->{ROOTEXT},$manpagename);
- }
- $manpagename =~ s/\.p(od|m|l)$//;
- # Strip leading slashes
- $manpagename =~ s!^/+!!;
- # Turn other slashes into colons
-# $manpagename =~ s,/+,::,g;
- $manpagename = $self->replace_manpage_seperator($manpagename);
- $manifypods{$name} = "\$(INST_MAN3DIR)/$manpagename.\$(MAN3EXT)";
- }
- $self->{MANPODS} = \%manifypods;
- }
-}
+=over 4
-sub lsdir {
- my($self) = shift;
- my($dir, $regex) = @_;
- local(*DIR, @ls);
- opendir(DIR, $dir || ".") or return ();
- @ls = readdir(DIR);
- closedir(DIR);
- @ls = grep(/$regex/, @ls) if $regex;
- @ls;
-}
+=item *
-sub replace_manpage_seperator {
- my($self,$man) = @_;
- $man =~ s,/+,::,g;
- $man;
-}
+setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
+INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
-sub libscan {
- my($self,$path) = @_;
- return '' if $path =~ m:/RCS/: ;
- $path;
-}
+=item *
-sub init_others { # --- Initialize Other Attributes
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
+without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
+part of those INSTALL* arguments, even if the latter are explicitly
+set (but are set to still start with C<$Config{prefix}>).
- # Compute EXTRALIBS, BSLOADLIBS and LDLOADLIBS from $self->{LIBS}
- # Lets look at $self->{LIBS} carefully: It may be an anon array, a string or
- # undefined. In any case we turn it into an anon array:
- $self->{LIBS}=[] unless $self->{LIBS};
- $self->{LIBS}=[$self->{LIBS}] if ref \$self->{LIBS} eq SCALAR;
- $self->{LD_RUN_PATH} = "";
- my($libs);
- foreach $libs ( @{$self->{LIBS}} ){
- $libs =~ s/^\s*(.*\S)\s*$/$1/; # remove leading and trailing whitespace
- my(@libs) = $self->extliblist($libs);
- if ($libs[0] or $libs[1] or $libs[2]){
- # LD_RUN_PATH now computed by ExtUtils::Liblist
- ($self->{EXTRALIBS}, $self->{BSLOADLIBS}, $self->{LDLOADLIBS}, $self->{LD_RUN_PATH}) = @libs;
- last;
- }
- }
+=back
- print STDOUT "CONFIG must be an array ref\n"
- if ($self->{CONFIG} and ref $self->{CONFIG} ne 'ARRAY');
- $self->{CONFIG} = [] unless (ref $self->{CONFIG});
- push(@{$self->{CONFIG}},
- qw(cc libc ldflags lddlflags ccdlflags cccdlflags
- ranlib so dlext dlsrc
- ));
- push(@{$self->{CONFIG}}, 'shellflags') if $Config::Config{shellflags};
-
- unless ( $self->{OBJECT} ){
- # init_dirscan should have found out, if we have C files
- $self->{OBJECT} = '$(BASEEXT)$(OBJ_EXT)' if @{$self->{C}||[]};
- }
- $self->{OBJECT} =~ s/\n+/ \\\n\t/g;
- $self->{BOOTDEP} = (-f "$self->{BASEEXT}_BS") ? "$self->{BASEEXT}_BS" : "";
- $self->{PERLMAINCC} ||= '$(CC)';
- $self->{LD} = ($Config::Config{ld} || 'ld') unless $self->{LD};
- $self->{LDFROM} = '$(OBJECT)' unless $self->{LDFROM};
-
- # Sanity check: don't define LINKTYPE = dynamic if we're skipping
- # the 'dynamic' section of MM. We don't have this problem with
- # 'static', since we either must use it (%Config says we can't
- # use dynamic loading) or the caller asked for it explicitly.
- if (!$self->{LINKTYPE}) {
- $self->{LINKTYPE} = grep(/dynamic/,@{$self->{SKIP} || []})
- ? 'static'
- : ($Config::Config{usedl} ? 'dynamic' : 'static');
- };
+If the user has superuser privileges, and is not working on AFS or
+relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
+INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
+the best:
- # These get overridden for VMS and maybe some other systems
- $self->{NOOP} = "";
- $self->{FIRST_MAKEFILE} ||= "Makefile";
- $self->{MAKEFILE} ||= $self->{FIRST_MAKEFILE};
- $self->{MAKE_APERL_FILE} ||= "Makefile.aperl";
- $self->{RM_F} = "rm -f";
- $self->{RM_RF} = "rm -rf";
- $self->{TOUCH} = "touch";
- $self->{CP} = "cp";
- $self->{MV} = "mv";
- $self->{CHMOD} = "chmod";
- $self->{UMASK_NULL} = "umask 0";
-}
+ perl Makefile.PL;
+ make;
+ make test
+ make install
-sub find_perl{
- my($self, $ver, $names, $dirs, $trace) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my($name, $dir);
- if ($trace >= 2){
- print "Looking for perl $ver by these names:
-@$names
-in these dirs:
-@$dirs
-";
- }
- foreach $dir (@$dirs){
- next unless defined $dir; # $self->{PERL_SRC} may be undefined
- foreach $name (@$names){
- my $abs;
- if ($name =~ m|^/|) {
- $abs = $name;
- } elsif ($name =~ m|/|) {
- $abs = $self->catfile(".", $name); # not absolute
- } else {
- $abs = $self->catfile($dir, $name);
- }
- print "Checking $abs\n" if ($trace >= 2);
- next unless $self->maybe_command($abs);
- print "Executing $abs\n" if ($trace >= 2);
- if (`$abs -e 'require $ver; print "VER_OK\n" ' 2>&1` =~ /VER_OK/) {
- print "Using PERL=$abs\n" if $trace;
- return $abs;
- }
- }
- }
- print STDOUT "Unable to find a perl $ver (by these names: @$names, in these dirs: @$dirs)\n";
- 0; # false and not empty
-}
+make install per default writes some documentation of what has been
+done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
+can be bypassed by calling make pure_install.
-sub maybe_command {
- my($self,$file) = @_;
- return 1 if -x $file && ! -d $file;
- return;
-}
+=head2 AFS users
-sub post_initialize {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- "";
-}
-
-# --- Constants Sections ---
-
-sub const_config {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m,$m);
- push(@m,"\n# These definitions are from config.sh (via $INC{'Config.pm'})\n");
- my(%once_only);
- foreach $m (@{$self->{CONFIG}}){
- next if $once_only{$m};
- print STDOUT "CONFIG key '$m' does not exist in Config.pm\n"
- unless exists $Config::Config{$m};
- push @m, "\U$m\E = $Config::Config{$m}\n";
- $once_only{$m} = 1;
- }
- join('', @m);
-}
-
-sub constants {
- my($self) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m,$tmp);
-
- push @m, "
-NAME = $self->{NAME}
-DISTNAME = $self->{DISTNAME}
-NAME_SYM = $self->{NAME_SYM}
-VERSION = $self->{VERSION}
-VERSION_SYM = $self->{VERSION_SYM}
-VERSION_MACRO = VERSION
-DEFINE_VERSION = -D\$(VERSION_MACRO)=\\\"\$(VERSION)\\\"
-
-# In which directory should we put this extension during 'make'?
-# This is typically ./blib.
-# (also see INST_LIBDIR and relationship to ROOTEXT)
-INST_LIB = $self->{INST_LIB}
-INST_ARCHLIB = $self->{INST_ARCHLIB}
-INST_EXE = $self->{INST_EXE}
-
-# AFS users will want to set the installation directories for
-# the final 'make install' early without setting INST_LIB,
-# INST_ARCHLIB, and INST_EXE for the testing phase
-INSTALLPRIVLIB = $self->{INSTALLPRIVLIB}
-INSTALLARCHLIB = $self->{INSTALLARCHLIB}
-INSTALLBIN = $self->{INSTALLBIN}
-
-# Perl library to use when building the extension
-PERL_LIB = $self->{PERL_LIB}
-PERL_ARCHLIB = $self->{PERL_ARCHLIB}
-LIBPERL_A = $self->{LIBPERL_A}
-
-MAKEMAKER = \$(PERL_LIB)/ExtUtils/MakeMaker.pm
-MM_VERSION = $ExtUtils::MakeMaker::VERSION
-FIRST_MAKEFILE = $self->{FIRST_MAKEFILE}
-MAKE_APERL_FILE = $self->{MAKE_APERL_FILE}
-
-OBJ_EXT = $self->{OBJ_EXT}
-LIB_EXT = $self->{LIB_EXT}
-PERLMAINCC = $self->{PERLMAINCC}
-AR = $self->{AR}
-";
-
- push @m, "
-# Where is the perl source code located?
-PERL_SRC = $self->{PERL_SRC}\n" if $self->{PERL_SRC};
-
- push @m, "
-# Perl header files (will eventually be under PERL_LIB)
-PERL_INC = $self->{PERL_INC}
-# Perl binaries
-PERL = $self->{PERL}
-FULLPERL = $self->{FULLPERL}
-";
- push @m, "
-# FULLEXT = Pathname for extension directory (eg DBD/Oracle).
-# BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT.
-# ROOTEXT = Directory part of FULLEXT with leading slash (eg /DBD)
-# DLBASE = Basename part of dynamic library. May be just equal BASEEXT.
-FULLEXT = $self->{FULLEXT}
-BASEEXT = $self->{BASEEXT}
-ROOTEXT = $self->{ROOTEXT}
-DLBASE = $self->{DLBASE}
-";
- push @m, "
-INC = $self->{INC}
-DEFINE = $self->{DEFINE}
-OBJECT = $self->{OBJECT}
-LDFROM = $self->{LDFROM}
-LINKTYPE = $self->{LINKTYPE}
-
-# Handy lists of source code files:
-XS_FILES= ".join(" \\\n\t", sort keys %{$self->{XS}})."
-C_FILES = ".join(" \\\n\t", @{$self->{C}})."
-O_FILES = ".join(" \\\n\t", @{$self->{O_FILES}})."
-H_FILES = ".join(" \\\n\t", @{$self->{H}})."
-MANPODS = ".join(" \\\n\t", sort keys %{$self->{MANPODS}})."
-
-# Man installation stuff:
-INST_MAN1DIR = $self->{INST_MAN1DIR}
-INSTALLMAN1DIR = $self->{INSTALLMAN1DIR}
-MAN1EXT = $self->{MAN1EXT}
-
-INST_MAN3DIR = $self->{INST_MAN3DIR}
-INSTALLMAN3DIR = $self->{INSTALLMAN3DIR}
-MAN3EXT = $self->{MAN3EXT}
-
-
-# work around a famous dec-osf make(1) feature(?):
-makemakerdflt: all
-
-.SUFFIXES: .xs .c \$(OBJ_EXT)
-
-# .PRECIOUS: Makefile # seems to be not necessary anymore
-
-.PHONY: all config static dynamic test linkext
-
-# This extension may link to it's own library (see SDBM_File)
-MYEXTLIB = $self->{MYEXTLIB}
-
-# Where is the Config information that we are using/depend on
-CONFIGDEP = \$(PERL_ARCHLIB)/Config.pm \$(PERL_INC)/config.h
-";
-
- push @m, '
-# Where to put things:
-INST_LIBDIR = $(INST_LIB)$(ROOTEXT)
-INST_ARCHLIBDIR = $(INST_ARCHLIB)$(ROOTEXT)
-
-INST_AUTODIR = $(INST_LIB)/auto/$(FULLEXT)
-INST_ARCHAUTODIR = $(INST_ARCHLIB)/auto/$(FULLEXT)
-';
-
- if ($self->has_link_code()) {
- push @m, '
-INST_STATIC = $(INST_ARCHAUTODIR)/$(BASEEXT)$(LIB_EXT)
-INST_DYNAMIC = $(INST_ARCHAUTODIR)/$(DLBASE).$(DLEXT)
-INST_BOOT = $(INST_ARCHAUTODIR)/$(BASEEXT).bs
-';
- } else {
- push @m, '
-INST_STATIC =
-INST_DYNAMIC =
-INST_BOOT =
-';
- }
-
- if ($Is_OS2) {
- $tmp = "$self->{BASEEXT}.def";
- } else {
- $tmp = "";
- }
- push @m, "
-EXPORT_LIST = $tmp
-";
-
- if ($Is_OS2) {
- $tmp = "\$(PERL_INC)/libperl.lib";
- } else {
- $tmp = "";
- }
- push @m, "
-PERL_ARCHIVE = $tmp
-";
-
- push @m, '
-INST_PM = '.join(" \\\n\t", sort values %{$self->{PM}}).'
-';
-
- join('',@m);
-}
-
-sub const_loadlibs {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return "" unless $self->needs_linking;
- "
-# $self->{NAME} might depend on some other libraries:
-# (These comments may need revising:)
-#
-# Dependent libraries can be linked in one of three ways:
-#
-# 1. (For static extensions) by the ld command when the perl binary
-# is linked with the extension library. See EXTRALIBS below.
-#
-# 2. (For dynamic extensions) by the ld command when the shared
-# object is built/linked. See LDLOADLIBS below.
-#
-# 3. (For dynamic extensions) by the DynaLoader when the shared
-# object is loaded. See BSLOADLIBS below.
-#
-# EXTRALIBS = List of libraries that need to be linked with when
-# linking a perl binary which includes this extension
-# Only those libraries that actually exist are included.
-# These are written to a file and used when linking perl.
-#
-# LDLOADLIBS = List of those libraries which can or must be linked into
-# the shared library when created using ld. These may be
-# static or dynamic libraries.
-# LD_RUN_PATH is a colon separated list of the directories
-# in LDLOADLIBS. It is passed as an environment variable to
-# the process that links the shared library.
-#
-# BSLOADLIBS = List of those libraries that are needed but can be
-# linked in dynamically at run time on this platform.
-# SunOS/Solaris does not need this because ld records
-# the information (from LDLOADLIBS) into the object file.
-# This list is used to create a .bs (bootstrap) file.
-#
-EXTRALIBS = $self->{EXTRALIBS}
-LDLOADLIBS = $self->{LDLOADLIBS}
-BSLOADLIBS = $self->{BSLOADLIBS}
-LD_RUN_PATH= $self->{LD_RUN_PATH}
-";
-}
-
-sub const_cccmd {
- my($self,$libperl)=@_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return $self->{CONST_CCCMD} if $self->{CONST_CCCMD};
- return '' unless $self->needs_linking();
- $libperl or $libperl = $self->{LIBPERL_A} || "libperl$self->{LIB_EXT}" ;
- $libperl =~ s/\.\$\(A\)$/$self->{LIB_EXT}/;
- # This is implemented in the same manner as extliblist,
- # e.g., do both and compare results during the transition period.
- my($cc,$ccflags,$optimize,$large,$split, $shflags)
- = @Config{qw(cc ccflags optimize large split shellflags)};
- my($optdebug) = "";
-
- $shflags = '' unless $shflags;
- my($prog, $old, $uc, $perltype);
-
- chop($old = `cd $self->{PERL_SRC}; sh $shflags ./cflags $libperl $self->{BASEEXT}.c`)
- if $self->{PERL_SRC};
-
- my(%map) = (
- D => '-DDEBUGGING',
- E => '-DEMBED',
- DE => '-DDEBUGGING -DEMBED',
- M => '-DEMBED -DMULTIPLICITY',
- DM => '-DDEBUGGING -DEMBED -DMULTIPLICITY',
- );
-
- if ($libperl =~ /libperl(\w*)\Q$self->{LIB_EXT}/){
- $uc = uc($1);
- } else {
- $uc = ""; # avoid warning
- }
- $perltype = $map{$uc} ? $map{$uc} : "";
-
- if ($uc =~ /^D/) {
- $optdebug = "-g";
- }
-
-
- my($name);
- ( $name = $self->{NAME} . "_cflags" ) =~ s/:/_/g ;
- if ($prog = $Config::Config{$name}) {
- # Expand hints for this extension via the shell
- print STDOUT "Processing $name hint:\n" if $ExtUtils::MakeMaker::Verbose;
- my(@o)=`cc=\"$cc\"
- ccflags=\"$ccflags\"
- optimize=\"$optimize\"
- perltype=\"$perltype\"
- optdebug=\"$optdebug\"
- large=\"$large\"
- split=\"$split\"
- eval '$prog'
- echo cc=\$cc
- echo ccflags=\$ccflags
- echo optimize=\$optimize
- echo perltype=\$perltype
- echo optdebug=\$optdebug
- echo large=\$large
- echo split=\$split
- `;
- my(%cflags,$line);
- foreach $line (@o){
- chomp $line;
- if ($line =~ /(.*?)=\s*(.*)\s*$/){
- $cflags{$1} = $2;
- print STDOUT " $1 = $2\n" if $ExtUtils::MakeMaker::Verbose;
- } else {
- print STDOUT "Unrecognised result from hint: '$line'\n";
- }
- }
- ( $cc,$ccflags,$perltype,$optdebug,$optimize,$large,$split )=@cflags{
- qw( cc ccflags perltype optdebug optimize large split)};
- }
-
- if ($optdebug) {
- $optimize = $optdebug;
- }
-
- my($new) = "$cc -c \$(INC) $ccflags $optimize $perltype $large $split";
- $new =~ s/^\s+//; $new =~ s/\s+/ /g; $new =~ s/\s+$//;
-# if (defined($old)){
-# $old =~ s/^\s+//; $old =~ s/\s+/ /g; $old =~ s/\s+$//;
-# if ($new ne $old) {
-# print STDOUT "Warning (non-fatal): cflags evaluation in ",
-# "MakeMaker ($ExtUtils::MakeMaker::VERSION) ",
-# "differs from shell output\n",
-# " package: $self->{NAME}\n",
-# " old: $old\n",
-# " new: $new\n",
-# " Using 'old' set.\n",
-# Config::myconfig(), "\n";
-# }
-# }
- my($cccmd)=($old) ? $old : $new;
- $cccmd =~ s/^\s*\Q$Config::Config{cc}\E\s/\$(CC) /;
- $cccmd .= " \$(DEFINE_VERSION)";
- $self->{CONST_CCCMD} = "CCCMD = $cccmd\n";
-}
-
-# --- Tool Sections ---
-
-sub tool_autosplit {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my($asl) = "";
- $asl = "\$AutoSplit::Maxlen=$attribs{MAXLEN};" if $attribs{MAXLEN};
- q{
-# Usage: $(AUTOSPLITFILE) FileToSplit AutoDirToSplitInto
-AUTOSPLITFILE = $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" -e 'use AutoSplit;}.$asl.q{autosplit($$ARGV[0], $$ARGV[1], 0, 1, 1) ;'
-};
-}
-
-sub tool_xsubpp {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my($xsdir) = '$(PERL_LIB)/ExtUtils';
- # drop back to old location if xsubpp is not in new location yet
- $xsdir = '$(PERL_SRC)/ext' unless (-f "$self->{PERL_LIB}/ExtUtils/xsubpp");
- my(@tmdeps) = ('$(XSUBPPDIR)/typemap');
- if( $self->{TYPEMAPS} ){
- my $typemap;
- foreach $typemap (@{$self->{TYPEMAPS}}){
- if( ! -f $typemap ){
- warn "Typemap $typemap not found.\n";
- }
- else{
- push(@tmdeps, $typemap);
- }
- }
- }
- push(@tmdeps, "typemap") if -f "typemap";
- my(@tmargs) = map("-typemap $_", @tmdeps);
- if( exists $self->{XSOPT} ){
- unshift( @tmargs, $self->{XSOPT} );
- }
- "
-XSUBPPDIR = $xsdir
-XSUBPP = \$(XSUBPPDIR)/xsubpp
-XSUBPPDEPS = @tmdeps
-XSUBPPARGS = @tmargs
-";
-};
-
-sub tools_other {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- "
-SHELL = /bin/sh
-LD = $self->{LD}
-TOUCH = $self->{TOUCH}
-CP = $self->{CP}
-MV = $self->{MV}
-RM_F = $self->{RM_F}
-RM_RF = $self->{RM_RF}
-CHMOD = $self->{CHMOD}
-UMASK_NULL = $self->{UMASK_NULL}
-".q{
-# The following is a portable way to say mkdir -p
-# To see which directories are created, change the if 0 to if 1
-MKPATH = $(PERL) -wle '$$"="/"; foreach $$p (@ARGV){' \\
--e 'next if -d $$p; my(@p); foreach(split(/\//,$$p)){' \\
--e 'push(@p,$$_); next if -d "@p/"; print "mkdir @p" if 0;' \\
--e 'mkdir("@p",0777)||die $$! } } exit 0;'
-};
-}
-
-sub dist {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m);
- # VERSION should be sanitised before use as a file name
- my($name) = $attribs{NAME} || '$(DISTVNAME)';
- my($tar) = $attribs{TAR} || 'tar'; # eg /usr/bin/gnutar
- my($tarflags) = $attribs{TARFLAGS} || 'cvf';
- my($compress) = $attribs{COMPRESS} || 'compress'; # eg gzip
- my($suffix) = $attribs{SUFFIX} || 'Z'; # eg gz
- my($shar) = $attribs{SHAR} || 'shar'; # eg "shar --gzip"
- my($preop) = $attribs{PREOP} || '@ true'; # eg update MANIFEST
- my($postop) = $attribs{POSTOP} || '@ true'; # eg remove the distdir
- my($ci) = $attribs{CI} || 'ci -u';
- my($rcs_label)= $attribs{RCS_LABEL}|| 'rcs -Nv$(VERSION_SYM): -q';
- my($dist_cp) = $attribs{DIST_CP} || 'best';
- my($dist_default) = $attribs{DIST_DEFAULT} || 'tardist';
-
- push @m, "
-DISTVNAME = \$(DISTNAME)-\$(VERSION)
-TAR = $tar
-TARFLAGS = $tarflags
-COMPRESS = $compress
-SUFFIX = $suffix
-SHAR = $shar
-PREOP = $preop
-POSTOP = $postop
-CI = $ci
-RCS_LABEL = $rcs_label
-DIST_CP = $dist_cp
-DIST_DEFAULT = $dist_default
-";
- join "", @m;
-}
-
-sub macro {
- my($self,%attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m,$key,$val);
- while (($key,$val) = each %attribs){
- push @m, "$key = $val\n";
- }
- join "", @m;
-}
-
-sub post_constants{
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- "";
-}
-
-sub pasthru {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m,$key);
-
- my(@pasthru);
-
- foreach $key (qw(INSTALLPRIVLIB INSTALLARCHLIB INSTALLBIN
- INSTALLMAN1DIR INSTALLMAN3DIR LIBPERL_A
- LINKTYPE)){
- push @pasthru, "$key=\"\$($key)\"";
- }
-
- push @m, "\nPASTHRU = ", join ("\\\n\t", @pasthru), "\n";
- join "", @m;
-}
-
-# --- Translation Sections ---
-
-sub c_o {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return '' unless $self->needs_linking();
- my(@m);
- push @m, '
-.c$(OBJ_EXT):
- $(CCCMD) $(CCCDLFLAGS) -I$(PERL_INC) $(DEFINE) $*.c
-';
- join "", @m;
-}
-
-sub xs_c {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return '' unless $self->needs_linking();
- '
-.xs.c:
- $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) $(XSUBPP) $(XSUBPPARGS) $*.xs >$*.tc && mv $*.tc $@
-';
-}
-
-sub xs_o { # many makes are too dumb to use xs_c then c_o
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return '' unless $self->needs_linking();
- '
-.xs$(OBJ_EXT):
- $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) $(XSUBPP) $(XSUBPPARGS) $*.xs >xstmp.c && mv xstmp.c $*.c
- $(CCCMD) $(CCCDLFLAGS) -I$(PERL_INC) $(DEFINE) $*.c
-';
-}
+will have to specify the installation directories as these most
+probably have changed since perl itself has been installed. They will
+have to do this by calling
-# --- Target Sections ---
+ perl Makefile.PL INSTALLSITELIB=/afs/here/today \
+ INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
+ make
-sub top_targets {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m);
- push @m, '
-all :: config $(INST_PM) subdirs linkext manifypods
+Be careful to repeat this procedure every time you recompile an
+extension, unless you are sure the AFS installation directories are
+still valid.
-subdirs :: $(MYEXTLIB)
+=head2 Static Linking of a new Perl Binary
-'.$self->{NOOP}.'
+An extension that is built with the above steps is ready to use on
+systems supporting dynamic loading. On systems that do not support
+dynamic loading, any newly created extension has to be linked together
+with the available resources. MakeMaker supports the linking process
+by creating appropriate targets in the Makefile whenever an extension
+is built. You can invoke the corresponding section of the makefile with
-config :: '.$self->{MAKEFILE}.' $(INST_LIBDIR)/.exists
+ make perl
-config :: $(INST_ARCHAUTODIR)/.exists Version_check
+That produces a new perl binary in the current directory with all
+extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
+and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
+UNIX, this is called Makefile.aperl (may be system dependent). If you
+want to force the creation of a new perl, it is recommended, that you
+delete this Makefile.aperl, so the directories are searched-through
+for linkable libraries again.
-config :: $(INST_AUTODIR)/.exists
+The binary can be installed into the directory where perl normally
+resides on your machine with
-config :: $(INST_MAN1DIR)/.exists
+ make inst_perl
-config :: $(INST_MAN3DIR)/.exists
-';
+To produce a perl binary with a different name than C<perl>, either say
+ perl Makefile.PL MAP_TARGET=myperl
+ make myperl
+ make inst_perl
+or say
-#postamble ist einfach leer!
+ perl Makefile.PL
+ make myperl MAP_TARGET=myperl
+ make inst_perl MAP_TARGET=myperl
- # 5.00 breaks with the incomplete rules set up by Tk-b8. We
- # introduce the following dependency for Tk-b8:
- if ($self->{NAME} eq 'Tk' && $self->{VERSION} eq 'b8') {
-# push @m, "
-#$(MYEXTLIB) ::
-# cd pTk";
- }
+In any case you will be prompted with the correct invocation of the
+C<inst_perl> target that installs the new binary into INSTALLBIN.
+make inst_perl per default writes some documentation of what has been
+done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
+can be bypassed by calling make pure_inst_perl.
+Warning: the inst_perl: target will most probably overwrite your
+existing perl binary. Use with care!
+Sometimes you might want to build a statically linked perl although
+your system supports dynamic loading. In this case you may explicitly
+set the linktype with the invocation of the Makefile.PL or make:
+ perl Makefile.PL LINKTYPE=static # recommended
- push @m, $self->dir_target(qw[$(INST_AUTODIR) $(INST_LIBDIR) $(INST_ARCHAUTODIR)
- $(INST_MAN1DIR) $(INST_MAN3DIR)]);
+or
- push @m, '
-$(O_FILES): $(H_FILES)
-' if @{$self->{O_FILES} || []} && @{$self->{H} || []};
+ make LINKTYPE=static # works on most systems
- push @m, q{
-help:
- perldoc ExtUtils::MakeMaker
-};
+=head2 Determination of Perl Library and Installation Locations
- push @m, q{
-Version_check:
- @$(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) \
- -e 'use ExtUtils::MakeMaker qw($$Version &Version_check);' \
- -e '&Version_check("$(MM_VERSION)")'
-};
+MakeMaker needs to know, or to guess, where certain things are
+located. Especially INST_LIB and INST_ARCHLIB (where to put the files
+during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
+existing modules from), and PERL_INC (header files and C<libperl*.*>).
- join('',@m);
-}
+Extensions may be built either using the contents of the perl source
+directory tree or from the installed perl library. The recommended way
+is to build extensions after you have run 'make install' on perl
+itself. You can do that in any directory on your hard disk that is not
+below the perl source tree. The support for extensions below the ext
+directory of the perl distribution is only good for the standard
+extensions that come with perl.
-sub linkext {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- # LINKTYPE => static or dynamic or ''
- my($linktype) = defined $attribs{LINKTYPE} ?
- $attribs{LINKTYPE} : '$(LINKTYPE)';
- "
-linkext :: $linktype
-$self->{NOOP}
-";
-}
+If an extension is being built below the C<ext/> directory of the perl
+source then MakeMaker will set PERL_SRC automatically (e.g.,
+C<../..>). If PERL_SRC is defined and the extension is recognized as
+a standard extension, then other variables default to the following:
-sub dlsyms {
- my($self,%attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
+ PERL_INC = PERL_SRC
+ PERL_LIB = PERL_SRC/lib
+ PERL_ARCHLIB = PERL_SRC/lib
+ INST_LIB = PERL_LIB
+ INST_ARCHLIB = PERL_ARCHLIB
- return '' if ($Config::Config{osname} ne 'aix');
+If an extension is being built away from the perl source then MakeMaker
+will leave PERL_SRC undefined and default to using the installed copy
+of the perl library. The other variables default to the following:
- my($funcs) = $attribs{DL_FUNCS} || $self->{DL_FUNCS} || {};
- my($vars) = $attribs{DL_VARS} || $self->{DL_VARS} || [];
- my(@m);
+ PERL_INC = $archlibexp/CORE
+ PERL_LIB = $privlibexp
+ PERL_ARCHLIB = $archlibexp
+ INST_LIB = ./blib/lib
+ INST_ARCHLIB = ./blib/arch
- push(@m,"
-dynamic :: $self->{BASEEXT}.exp
+If perl has not yet been installed then PERL_SRC can be defined on the
+command line as shown in the previous section.
-") unless $self->{SKIPHASH}{dynamic};
- push(@m,"
-static :: $self->{BASEEXT}.exp
+=head2 Which architecture dependent directory?
-") unless $self->{SKIPHASH}{static};
+If you don't want to keep the defaults for the INSTALL* macros,
+MakeMaker helps you to minimize the typing needed: the usual
+relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
+by Configure at perl compilation time. MakeMaker supports the user who
+sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
+then MakeMaker defaults the latter to be the same subdirectory of
+INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
+otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
+for INSTALLSITELIB and INSTALLSITEARCH.
- push(@m,"
-$self->{BASEEXT}.exp: Makefile.PL
-",' $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" -e \'use ExtUtils::MakeMaker qw(&mksymlists); \\
- MM->mksymlists({DL_FUNCS => ',
- %$funcs ? neatvalue($funcs) : '""',', DL_VARS => ',
- @$vars ? neatvalue($vars) : '""', ", NAME => \"$self->{NAME}\"})'
-");
+MakeMaker gives you much more freedom than needed to configure
+internal variables and get different results. It is worth to mention,
+that make(1) also lets you configure most of the variables that are
+used in the Makefile. But in the majority of situations this will not
+be necessary, and should only be done if the author of a package
+recommends it (or you know what you're doing).
- join('',@m);
-}
+=head2 Using Attributes and Parameters
-# --- Dynamic Loading Sections ---
+The following attributes may be specified as arguments to WriteMakefile()
+or as NAME=VALUE pairs on the command line.
-sub dynamic {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- '
-# $(INST_PM) has been moved to the all: target.
-# It remains here for awhile to allow for old usage: "make dynamic"
-dynamic :: '.$self->{MAKEFILE}.' $(INST_DYNAMIC) $(INST_BOOT) $(INST_PM)
-'.$self->{NOOP}.'
-';
-}
+=over 2
-sub dynamic_bs {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return '' unless $self->needs_linking();
- '
-BOOTSTRAP = '."$self->{BASEEXT}.bs".'
-
-# As Mkbootstrap might not write a file (if none is required)
-# we use touch to prevent make continually trying to remake it.
-# The DynaLoader only reads a non-empty file.
-$(BOOTSTRAP): '."$self->{MAKEFILE} $self->{BOOTDEP}".'
- @ echo "Running Mkbootstrap for $(NAME) ($(BSLOADLIBS))"
- @ $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" \
- -e \'use ExtUtils::Mkbootstrap;\' \
- -e \'Mkbootstrap("$(BASEEXT)","$(BSLOADLIBS)");\'
- @ $(TOUCH) $(BOOTSTRAP)
- $(CHMOD) 644 $@
- @echo $@ >> $(INST_ARCHAUTODIR)/.packlist
-
-$(INST_BOOT): $(BOOTSTRAP)
- @ '.$self->{RM_RF}.' $(INST_BOOT)
- -'.$self->{CP}.' $(BOOTSTRAP) $(INST_BOOT)
- $(CHMOD) 644 $@
- @echo $@ >> $(INST_ARCHAUTODIR)/.packlist
-';
-}
+=item ABSTRACT
-sub dynamic_lib {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return '' unless $self->needs_linking(); #might be because of a subdir
+One line description of the module. Will be included in PPD file.
- return '
-$(INST_DYNAMIC):
-' unless ($self->{OBJECT} or @{$self->{C} || []} or $self->{MYEXTLIB});
+=item ABSTRACT_FROM
- my($otherldflags) = $attribs{OTHERLDFLAGS} || "";
- my($armaybe) = $attribs{ARMAYBE} || $self->{ARMAYBE} || ":";
- my($ldfrom) = '$(LDFROM)';
- my($osname) = $Config::Config{osname};
- $armaybe = 'ar' if ($osname eq 'dec_osf' and $armaybe eq ':');
- my(@m);
- push(@m,'
-# This section creates the dynamically loadable $(INST_DYNAMIC)
-# from $(OBJECT) and possibly $(MYEXTLIB).
-ARMAYBE = '.$armaybe.'
-OTHERLDFLAGS = '.$otherldflags.'
-
-$(INST_DYNAMIC): $(OBJECT) $(MYEXTLIB) $(BOOTSTRAP) $(INST_ARCHAUTODIR)/.exists $(EXPORT_LIST) $(PERL_ARCHIVE)
-');
- if ($armaybe ne ':'){
- $ldfrom = 'tmp$(LIB_EXT)';
- push(@m,' $(ARMAYBE) cr '.$ldfrom.' $(OBJECT)'."\n");
- push(@m,' $(RANLIB) '."$ldfrom\n");
- }
- $ldfrom = "-all $ldfrom -none" if ($osname eq 'dec_osf');
- push(@m,' LD_RUN_PATH="$(LD_RUN_PATH)" $(LD) -o $@ $(LDDLFLAGS) '.$ldfrom.
- ' $(OTHERLDFLAGS) $(MYEXTLIB) $(LDLOADLIBS) $(EXPORT_LIST) $(PERL_ARCHIVE)');
- push @m, '
- $(CHMOD) 755 $@
- @echo $@ >> $(INST_ARCHAUTODIR)/.packlist
-';
-
- push @m, $self->dir_target('$(INST_ARCHAUTODIR)');
- join('',@m);
-}
+Name of the file that contains the package description. MakeMaker looks
+for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
+the first line in the "=head1 NAME" section. $2 becomes the abstract.
-# --- Static Loading Sections ---
+=item AUTHOR
-sub static {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- '
-# $(INST_PM) has been moved to the all: target.
-# It remains here for awhile to allow for old usage: "make static"
-static :: '.$self->{MAKEFILE}.' $(INST_STATIC) $(INST_PM)
-'.$self->{NOOP}.'
-';
-}
+String containing name (and email address) of package author(s). Is used
+in PPD (Perl Package Description) files for PPM (Perl Package Manager).
-sub static_lib {
- my($self) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return '' unless $self->needs_linking(); #might be because of a subdir
+=item BINARY_LOCATION
- return '
-$(INST_DYNAMIC):
-' unless ($self->{OBJECT} or @{$self->{C} || []} or $self->{MYEXTLIB});
+Used when creating PPD files for binary packages. It can be set to a
+full or relative path or URL to the binary archive for a particular
+architecture. For example:
- my(@m);
- push(@m, <<'END');
-$(INST_STATIC): $(OBJECT) $(MYEXTLIB) $(INST_ARCHAUTODIR)/.exists
-END
- # If this extension has it's own library (eg SDBM_File)
- # then copy that to $(INST_STATIC) and add $(OBJECT) into it.
- push(@m, " $self->{CP} \$(MYEXTLIB) \$\@\n") if $self->{MYEXTLIB};
-
- push(@m, <<'END');
- $(AR) cr $@ $(OBJECT) && $(RANLIB) $@
- @echo "$(EXTRALIBS)" > $(INST_ARCHAUTODIR)/extralibs.ld
- $(CHMOD) 755 $@
- @echo $@ >> $(INST_ARCHAUTODIR)/.packlist
-END
+ perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
-# Old mechanism - still available:
+builds a PPD package that references a binary of the C<Agent> package,
+located in the C<x86> directory relative to the PPD itself.
- push(@m, <<'END') if $self->{PERL_SRC};
- @ echo "$(EXTRALIBS)" >> $(PERL_SRC)/ext.libs
-END
+=item C
- push @m, $self->dir_target('$(INST_ARCHAUTODIR)');
- join('', "\n",@m);
-}
+Ref to array of *.c file names. Initialised from a directory scan
+and the values portion of the XS attribute hash. This is not
+currently used by MakeMaker but may be handy in Makefile.PLs.
-sub installpm {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- # By default .pm files are split into the architecture independent
- # library. This is a good thing. If a specific module requires that
- # it's .pm files are split into the architecture specific library
- # then it should use: installpm => {SPLITLIB=>'$(INST_ARCHLIB)'}
- # Note that installperl currently interferes with this (Config.pm)
- # User can disable split by saying: installpm => {SPLITLIB=>''}
- my($splitlib) = '$(INST_LIB)'; # NOT arch specific by default
- $splitlib = $attribs{SPLITLIB} if exists $attribs{SPLITLIB};
- my(@m, $dist);
- push @m, "inst_pm :: \$(INST_PM)\n\n";
- foreach $dist (sort keys %{$self->{PM}}){
- my($inst) = $self->{PM}->{$dist};
- push(@m, "\n# installpm: $dist => $inst, splitlib=$splitlib\n");
- push(@m, $self->installpm_x($dist, $inst, $splitlib));
- push(@m, "\n");
- }
- join('', @m);
-}
+=item CCFLAGS
-sub installpm_x { # called by installpm per file
- my($self, $dist, $inst, $splitlib) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- warn "Warning: Most probably 'make' will have problems processing this file: $inst\n"
- if $inst =~ m![:#]!;
- my($instdir) = $inst =~ m|(.*)/|;
- my(@m);
- push(@m,"
-$inst: $dist $self->{MAKEFILE} $instdir/.exists
-".' @ '.$self->{RM_F}.' $@
- $(UMASK_NULL) && '."$self->{CP} $dist".' $@
- @ echo $@ >> $(INST_ARCHAUTODIR)/.packlist
-');
- push(@m, "\t\@\$(AUTOSPLITFILE) \$@ $splitlib/auto\n")
- if ($splitlib and $inst =~ m/\.pm$/);
-
- push @m, $self->dir_target($instdir);
- join('', @m);
-}
+String that will be included in the compiler call command line between
+the arguments INC and OPTIMIZE.
-sub manifypods {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return "\nmanifypods :\n" unless %{$self->{MANPODS}};
- my($dist);
- my($pod2man_exe);
- if (defined $self->{PERL_SRC}) {
- $pod2man_exe = "$self->{PERL_SRC}/pod/pod2man";
- } else {
- $pod2man_exe = "$Config{bin}/pod2man";
- }
- unless ($self->maybe_command($pod2man_exe)) {
- # No pod2man but some MANPODS to be installed
- print <<END;
+=item CONFIG
-Warning: I could not locate your pod2man program. Please make sure,
- your pod2man program is in your PATH before you execute 'make'
+Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
+config.sh. MakeMaker will add to CONFIG the following values anyway:
+ar
+cc
+cccdlflags
+ccdlflags
+dlext
+dlsrc
+ld
+lddlflags
+ldflags
+libc
+lib_ext
+obj_ext
+ranlib
+sitelibexp
+sitearchexp
+so
-END
- $pod2man_exe = "-S pod2man";
- }
- my(@m);
- push @m,
-qq[POD2MAN_EXE = $pod2man_exe\n],
-q[POD2MAN = $(PERL) -we '%m=@ARGV;for (keys %m){' \\
--e 'next if -e $$m{$$_} && -M $$m{$$_} < -M "].$self->{MAKEFILE}.q[";' \\
--e 'print "Installing $$m{$$_}\n";' \\
--e 'system("$(PERL) $(POD2MAN_EXE) $$_>$$m{$$_}")==0 or warn "Couldn\\047t install $$m{$$_}\n";' \\
--e 'chmod 0644, $$m{$$_} or warn "chmod 644 $$m{$$_}: $$!\n";}'
-];
- push @m, "\nmanifypods :";
-
- push(@m,"\n");
- if (%{$self->{MANPODS}}) {
- push @m, "\t\@\$(POD2MAN) \\\t";
- push @m, join " \\\n\t", %{$self->{MANPODS}};
- }
- join('', @m);
-}
+=item CONFIGURE
-sub processPL {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- return "" unless $self->{PL_FILES};
- my(@m, $plfile);
- foreach $plfile (sort keys %{$self->{PL_FILES}}) {
- push @m, "
-all :: $self->{PL_FILES}->{$plfile}
-
-$self->{PL_FILES}->{$plfile} :: $plfile
- \$(PERL) -I\$(INST_ARCHLIB) -I\$(INST_LIB) -I\$(PERL_ARCHLIB) -I\$(PERL_LIB) $plfile
-";
- }
- join "", @m;
-}
+CODE reference. The subroutine should return a hash reference. The
+hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
+be determined by some evaluation method.
-sub installbin {
- my($self) = shift;
- return "" unless $self->{EXE_FILES} && ref $self->{EXE_FILES} eq "ARRAY";
- my(@m, $from, $to, %fromto, @to);
- push @m, $self->dir_target(qw[$(INST_EXE)]);
- for $from (@{$self->{EXE_FILES}}) {
- my($path)= '$(INST_EXE)/' . basename($from);
- local($_) = $path; # for backwards compatibility
- $to = $self->exescan($path);
- print "exescan($from) => '$to'\n" if ($ExtUtils::MakeMaker::Verbose >=2);
- $fromto{$from}=$to;
- }
- @to = values %fromto;
- push(@m, "
-EXE_FILES = @{$self->{EXE_FILES}}
-
-all :: @to
-
-realclean ::
- $self->{RM_F} @to
-");
-
- while (($from,$to) = each %fromto) {
- my $todir = dirname($to);
- push @m, "
-$to: $from $self->{MAKEFILE} $todir/.exists
- $self->{CP} $from $to
-";
- }
- join "", @m;
-}
+=item DEFINE
-sub exescan {
- my($self,$path) = @_;
- $path;
-}
-# --- Sub-directory Sections ---
+Something like C<"-DHAVE_UNISTD_H">
-sub subdirs {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m,$dir);
- # This method provides a mechanism to automatically deal with
- # subdirectories containing further Makefile.PL scripts.
- # It calls the subdir_x() method for each subdirectory.
- foreach $dir (@{$self->{DIR}}){
- push(@m, $self->subdir_x($dir));
-#### print "Including $dir subdirectory\n";
- }
- if (@m){
- unshift(@m, "
-# The default clean, realclean and test targets in this Makefile
-# have automatically been given entries for each subdir.
+=item DESTDIR
-");
- } else {
- push(@m, "\n# none")
- }
- join('',@m);
-}
+This is the root directory into which the code will be installed. It
+I<prepends itself to the normal prefix>. For example, if your code
+would normally go into /usr/local/lib/perl you could set DESTDIR=/tmp/
+and installation would go into /tmp/usr/local/lib/perl.
-sub runsubdirpl{ # Experimental! See subdir_x section
- my($self,$subdir) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- chdir($subdir) or die "chdir($subdir): $!";
- #ExtUtils::MakeMaker::check_hints();
- package main;
- require "Makefile.PL";
-}
+This is primarily of use for people who repackage Perl modules.
-sub subdir_x {
- my($self, $subdir) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m);
- qq{
+NOTE: Due to the nature of make, it is important that you put the trailing
+slash on your DESTDIR. "/tmp/" not "/tmp".
-subdirs ::
- \@-cd $subdir && \$(MAKE) all \$(PASTHRU)
+=item DIR
-};
-}
+Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
+] in ext/SDBM_File
-# --- Cleanup and Distribution Sections ---
+=item DISTNAME
-sub clean {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m,$dir);
- push(@m, '
-# Delete temporary files but do not touch installed files. We don\'t delete
-# the Makefile here so a later make realclean still has a makefile to use.
-
-clean ::
-');
- # clean subdirectories first
- for $dir (@{$self->{DIR}}) {
- push @m, "\t-cd $dir && test -f $self->{MAKEFILE} && \$(MAKE) clean\n";
- }
+A safe filename for the package.
- my(@otherfiles) = values %{$self->{XS}}; # .c files from *.xs files
- push(@otherfiles, $attribs{FILES}) if $attribs{FILES};
- push(@otherfiles, qw[./blib Makeaperlfile $(INST_ARCHAUTODIR)/extralibs.all
- perlmain.c mon.out core so_locations
- *~ */*~ */*/*~
- *$(OBJ_EXT) *$(LIB_EXT)
- perl.exe $(BOOTSTRAP) $(BASEEXT).bso $(BASEEXT).def $(BASEEXT).exp
- ]);
- push @m, "\t-$self->{RM_RF} @otherfiles\n";
- # See realclean and ext/utils/make_ext for usage of Makefile.old
- push(@m,
- "\t-$self->{MV} $self->{MAKEFILE} $self->{MAKEFILE}.old 2>/dev/null\n");
- push(@m,
- "\t$attribs{POSTOP}\n") if $attribs{POSTOP};
- join("", @m);
-}
+Defaults to NAME above but with :: replaced with -.
-sub realclean {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m);
- push(@m,'
-# Delete temporary files (via clean) and also delete installed files
-realclean purge :: clean
-');
- # realclean subdirectories first (already cleaned)
- my $sub = "\t-cd %s && test -f %s && \$(MAKE) %s realclean\n";
- foreach(@{$self->{DIR}}){
- push(@m, sprintf($sub,$_,"$self->{MAKEFILE}.old","-f $self->{MAKEFILE}.old"));
- push(@m, sprintf($sub,$_,"$self->{MAKEFILE}",''));
- }
- push(@m, " $self->{RM_RF} \$(INST_AUTODIR) \$(INST_ARCHAUTODIR)\n");
- push(@m, " $self->{RM_F} \$(INST_DYNAMIC) \$(INST_BOOT)\n");
- push(@m, " $self->{RM_F} \$(INST_STATIC) \$(INST_PM)\n");
- my(@otherfiles) = ($self->{MAKEFILE},
- "$self->{MAKEFILE}.old"); # Makefiles last
- push(@otherfiles, $attribs{FILES}) if $attribs{FILES};
- push(@m, " $self->{RM_RF} @otherfiles\n") if @otherfiles;
- push(@m, " $attribs{POSTOP}\n") if $attribs{POSTOP};
- join("", @m);
-}
+For example, Foo::Bar becomes Foo-Bar.
-sub dist_basics {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my @m;
- push @m, q{
-distclean :: realclean distcheck
-};
-
- push @m, q{
-distcheck :
- $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&fullcheck";' \\
- -e 'fullcheck();'
-};
-
- push @m, q{
-skipcheck :
- $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&skipcheck";' \\
- -e 'skipcheck();'
-};
-
- push @m, q{
-manifest :
- $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&mkmanifest";' \\
- -e 'mkmanifest();'
-};
- join "", @m;
-}
+=item DISTVNAME
-sub dist_core {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my @m;
- push @m, q{
-dist : $(DIST_DEFAULT)
-
-tardist : $(DISTVNAME).tar.$(SUFFIX)
-
-$(DISTVNAME).tar.$(SUFFIX) : distdir
- $(PREOP)
- $(TAR) $(TARFLAGS) $(DISTVNAME).tar $(DISTVNAME)
- $(RM_RF) $(DISTVNAME)
- $(COMPRESS) $(DISTVNAME).tar
- $(POSTOP)
-
-uutardist : $(DISTVNAME).tar.$(SUFFIX)
- uuencode $(DISTVNAME).tar.$(SUFFIX) \\
- $(DISTVNAME).tar.$(SUFFIX) > \\
- $(DISTVNAME).tar.$(SUFFIX).uu
-
-shdist : distdir
- $(PREOP)
- $(SHAR) $(DISTVNAME) > $(DISTVNAME).shar
- $(RM_RF) $(DISTVNAME)
- $(POSTOP)
-};
- join "", @m;
-}
+Your name for distributing the package with the version number
+included. This is used by 'make dist' to name the resulting archive
+file.
-sub dist_dir {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my @m;
- push @m, q{
-distdir :
- $(RM_RF) $(DISTVNAME)
- $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "/mani/";' \\
- -e 'manicopy(maniread(),"$(DISTVNAME)", "$(DIST_CP)");'
-};
- join "", @m;
-}
+Defaults to DISTNAME-VERSION.
-sub dist_test {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my @m;
- push @m, q{
-disttest : distdir
- cd $(DISTVNAME) && $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) Makefile.PL
- cd $(DISTVNAME) && $(MAKE)
- cd $(DISTVNAME) && $(MAKE) test
-};
- join "", @m;
-}
+For example, version 1.04 of Foo::Bar becomes Foo-Bar-1.04.
-sub dist_ci {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my @m;
- push @m, q{
-ci :
- $(PERL) -I$(PERL_ARCHLIB) -I$(PERL_LIB) -e 'use ExtUtils::Manifest "&maniread";' \\
- -e '@all = keys %{ maniread() };' \\
- -e 'print("Executing $(CI) @all\n"); system("$(CI) @all");' \\
- -e 'print("Executing $(RCS_LABEL) ...\n"); system("$(RCS_LABEL) @all");'
-};
- join "", @m;
-}
+On some OS's where . has special meaning VERSION_SYM may be used in
+place of VERSION.
-sub install {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m);
- push @m, q{
-doc_install ::
- @ echo Appending installation info to $(INSTALLARCHLIB)/perllocal.pod
- @ $(PERL) -I$(INST_ARCHLIB) -I$(INST_LIB) -I$(PERL_ARCHLIB) -I$(PERL_LIB) \\
- -e "use ExtUtils::MakeMaker; MY->new({})->writedoc('Module', '$(NAME)', \\
- 'LINKTYPE=$(LINKTYPE)', 'VERSION=$(VERSION)', \\
- 'EXE_FILES=$(EXE_FILES)')" >> $(INSTALLARCHLIB)/perllocal.pod
-};
-
- push(@m, "
-install :: pure_install doc_install
-
-pure_install ::
-");
- # install subdirectories first
- push(@m, map("\tcd $_ && test -f $self->{MAKEFILE} && \$(MAKE) install\n",
- @{$self->{DIR}}));
-
- push(@m, "\t\@\$(PERL) \"-I\$(PERL_ARCHLIB)\" \"-I\$(PERL_LIB)\" -e 'require File::Path;' \\
- -e '\$\$message = q[ You do not have permissions to install into];' \\
- -e 'File::Path::mkpath(\@ARGV);' \\
- -e 'foreach (\@ARGV){ die qq{ \$\$message \$\$_\\n} unless -w \$\$_}' \\
- \$(INSTALLPRIVLIB) \$(INSTALLARCHLIB)
- \$(MAKE) INST_LIB=\$(INSTALLPRIVLIB) INST_ARCHLIB=\$(INSTALLARCHLIB) INST_EXE=\$(INSTALLBIN) INST_MAN1DIR=\$(INSTALLMAN1DIR) INST_MAN3DIR=\$(INSTALLMAN3DIR) all
- \@\$(PERL) -i.bak -lne 'print unless \$\$seen{ \$\$_ }++' \$(INSTALLARCHLIB)/auto/\$(FULLEXT)/.packlist
-");
-
- push @m, '
-#### UNINSTALL IS STILL EXPERIMENTAL ####
-uninstall ::
-';
-
- push(@m, map("\tcd $_ && test -f $self->{MAKEFILE} && \$(MAKE) uninstall\n",
- @{$self->{DIR}}));
- push @m, "\t".'$(RM_RF) `cat $(INSTALLARCHLIB)/auto/$(FULLEXT)/.packlist`
-';
-
- join("",@m);
-}
+=item DL_FUNCS
+Hashref of symbol names for routines to be made available as universal
+symbols. Each key/value pair consists of the package name and an
+array of routine names in that package. Used only under AIX, OS/2,
+VMS and Win32 at present. The routine names supplied will be expanded
+in the same way as XSUB names are expanded by the XS() macro.
+Defaults to
-sub force {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- '# Phony target to force checking subdirectories.
-FORCE:
-';
-}
+ {"$(NAME)" => ["boot_$(NAME)" ] }
+e.g.
-sub perldepend {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m);
- push(@m,'
-PERL_HDRS = $(PERL_INC)/EXTERN.h $(PERL_INC)/INTERN.h \
- $(PERL_INC)/XSUB.h $(PERL_INC)/av.h $(PERL_INC)/cop.h \
- $(PERL_INC)/cv.h $(PERL_INC)/dosish.h $(PERL_INC)/embed.h \
- $(PERL_INC)/form.h $(PERL_INC)/gv.h $(PERL_INC)/handy.h \
- $(PERL_INC)/hv.h $(PERL_INC)/keywords.h $(PERL_INC)/mg.h \
- $(PERL_INC)/op.h $(PERL_INC)/opcode.h $(PERL_INC)/patchlevel.h \
- $(PERL_INC)/perl.h $(PERL_INC)/perly.h $(PERL_INC)/pp.h \
- $(PERL_INC)/proto.h $(PERL_INC)/regcomp.h $(PERL_INC)/regexp.h \
- $(PERL_INC)/scope.h $(PERL_INC)/sv.h $(PERL_INC)/unixish.h \
- $(PERL_INC)/util.h $(PERL_INC)/config.h
-
-');
-
- push @m, '
-$(OBJECT) : $(PERL_HDRS)
-' if $self->{OBJECT};
-
- push(@m,'
-# Check for unpropogated config.sh changes. Should never happen.
-# We do NOT just update config.h because that is not sufficient.
-# An out of date config.h is not fatal but complains loudly!
-$(PERL_INC)/config.h: $(PERL_SRC)/config.sh
- -@echo "Warning: $(PERL_INC)/config.h out of date with $(PERL_SRC)/config.sh"; false
-
-$(PERL_ARCHLIB)/Config.pm: $(PERL_SRC)/config.sh
- @echo "Warning: $(PERL_ARCHLIB)/Config.pm may be out of date with $(PERL_SRC)/config.sh"
- cd $(PERL_SRC) && $(MAKE) lib/Config.pm
-') if $self->{PERL_SRC};
-
- push(@m, join(" ", values %{$self->{XS}})." : \$(XSUBPPDEPS)\n")
- if %{$self->{XS}};
- join("\n",@m);
-}
+ {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
+ "NetconfigPtr" => [ 'DESTROY'] }
-sub makefile {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my @m;
- # We do not know what target was originally specified so we
- # must force a manual rerun to be sure. But as it should only
- # happen very rarely it is not a significant problem.
- push @m, '
-$(OBJECT) : $(FIRST_MAKEFILE)
-' if $self->{OBJECT};
-
- push @m, '
-# We take a very conservative approach here, but it\'s worth it.
-# We move Makefile to Makefile.old here to avoid gnu make looping.
-'.$self->{MAKEFILE}.' : Makefile.PL $(CONFIGDEP)
- @echo "Makefile out-of-date with respect to $?"
- @echo "Cleaning current config before rebuilding Makefile..."
- -@mv '."$self->{MAKEFILE} $self->{MAKEFILE}.old".'
- -$(MAKE) -f '.$self->{MAKEFILE}.'.old clean >/dev/null 2>&1 || true
- $(PERL) "-I$(PERL_ARCHLIB)" "-I$(PERL_LIB)" Makefile.PL '."@ARGV".'
- @echo ">>> Your Makefile has been rebuilt. <<<"
- @echo ">>> Please rerun the make command. <<<"; false
-';
-
- join "", @m;
-}
+Please see the L<ExtUtils::Mksymlists> documentation for more information
+about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
-sub staticmake {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@static);
+=item DL_VARS
- my(%searchdirs)=($self->{PERL_ARCHLIB} => 1, $self->{INST_ARCHLIB} => 1);
- my(@searchdirs)=keys %searchdirs;
+Array of symbol names for variables to be made available as universal symbols.
+Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
+(e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
- # And as it's not yet built, we add the current extension
- # but only if it has some C code (or XS code, which implies C code)
- if (@{$self->{C}}) {
- @static="$self->{INST_ARCHLIB}/auto/$self->{FULLEXT}/$self->{BASEEXT}$self->{LIB_EXT}";
- }
+=item EXCLUDE_EXT
- # Either we determine now, which libraries we will produce in the
- # subdirectories or we do it at runtime of the make.
+Array of extension names to exclude when doing a static build. This
+is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
+details. (e.g. [ qw( Socket POSIX ) ] )
- # We could ask all subdir objects, but I cannot imagine, why it
- # would be necessary.
+This attribute may be most useful when specified as a string on the
+command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
- # Instead we determine all libraries for the new perl at
- # runtime.
- my(@perlinc) = ($self->{INST_ARCHLIB}, $self->{INST_LIB}, $self->{PERL_ARCHLIB}, $self->{PERL_LIB});
+=item EXE_FILES
- $self->makeaperl(MAKE => $self->{MAKEFILE},
- DIRS => \@searchdirs,
- STAT => \@static,
- INCL => \@perlinc,
- TARGET => $self->{MAP_TARGET},
- TMP => "",
- LIBPERL => $self->{LIBPERL_A}
- );
-}
+Ref to array of executable files. The files will be copied to the
+INST_SCRIPT directory. Make realclean will delete them from there
+again.
-# --- Test and Installation Sections ---
+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.
-sub test {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my($tests) = $attribs{TESTS} || (-d "t" ? "t/*.t" : "");
- my(@m);
- push(@m,"
-TEST_VERBOSE=0
-TEST_TYPE=test_\$(LINKTYPE)
-
-test :: \$(TEST_TYPE)
-");
- push(@m, map("\t\@cd $_ && test -f $self->{MAKEFILE} && \$(MAKE) test \$(PASTHRU)\n",
- @{$self->{DIR}}));
- push(@m, "\t\@echo 'No tests defined for \$(NAME) extension.'\n")
- unless $tests or -f "test.pl" or @{$self->{DIR}};
- push(@m, "\n");
-
- push(@m, "test_dynamic :: all\n");
- push(@m, $self->test_via_harness('$(FULLPERL)', $tests)) if $tests;
- push(@m, $self->test_via_script('$(FULLPERL)', 'test.pl')) if -f "test.pl";
- push(@m, "\n");
-
- # Occasionally we may face this degenerated target:
- push @m, "test_ : test_dynamic\n\n";
-
- if ($self->needs_linking()) {
- push(@m, "test_static :: all \$(MAP_TARGET)\n");
- push(@m, $self->test_via_harness('./$(MAP_TARGET)', $tests)) if $tests;
- push(@m, $self->test_via_script('./$(MAP_TARGET)', 'test.pl')) if -f "test.pl";
- push(@m, "\n");
- } else {
- push @m, "test_static :: test_dynamic\n";
- }
- join("", @m);
-}
+=item FIRST_MAKEFILE
-sub test_via_harness {
- my($self, $perl, $tests) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- "\tPERL_DL_NONLAZY=1 $perl".q! -I$(INST_ARCHLIB) -I$(INST_LIB) -I$(PERL_ARCHLIB) -I$(PERL_LIB) -e 'use Test::Harness qw(&runtests $$verbose); $$verbose=$(TEST_VERBOSE); runtests @ARGV;' !."$tests\n";
-}
+The name of the Makefile to be produced. This is used for the second
+Makefile that will be produced for the MAP_TARGET.
-sub test_via_script {
- my($self, $perl, $script) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- "\tPERL_DL_NONLAZY=1 $perl".' -I$(INST_ARCHLIB) -I$(INST_LIB) -I$(PERL_ARCHLIB) -I$(PERL_LIB) test.pl
-';
-}
+Defaults to 'Makefile' or 'Descrip.MMS' on VMS.
+(Note: we couldn't use MAKEFILE because dmake uses this for something
+else).
-sub postamble {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- "";
-}
+=item FULLPERL
-sub makeaperl {
- my($self, %attribs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my($makefilename, $searchdirs, $static, $extra, $perlinc, $target, $tmp, $libperl) =
- @attribs{qw(MAKE DIRS STAT EXTRA INCL TARGET TMP LIBPERL)};
- my(@m);
- push @m, "
-# --- MakeMaker makeaperl section ---
-MAP_TARGET = $target
-FULLPERL = $self->{FULLPERL}
-";
- return join '', @m if $self->{PARENT};
-
- my($dir) = join ":", @{$self->{DIR}};
-
- unless ($self->{MAKEAPERL}) {
- push @m, q{
-$(MAP_TARGET) :: $(MAKE_APERL_FILE)
- $(MAKE) -f Makefile.aperl static $@
-
-$(MAKE_APERL_FILE) : $(FIRST_MAKEFILE)
- @ echo Writing \"Makefile.aperl\" for this $(MAP_TARGET)
- @ $(PERL) -I$(INST_ARCHLIB) -I$(INST_LIB) -I$(PERL_ARCHLIB) -I$(PERL_LIB) \
- Makefile.PL DIR=}, $dir, q{ \
- MAKEFILE=$(MAKE_APERL_FILE) LINKTYPE=static \
- MAKEAPERL=1 NORECURS=1};
-
- push @m, map( " \\\n\t\t$_", @ARGV );
- push @m, "\n";
-
- return join '', @m;
- }
+Perl binary able to run this extension, load XS modules, etc...
-
-
- my($cccmd, $linkcmd, $lperl);
-
-
- $cccmd = $self->const_cccmd($libperl);
- $cccmd =~ s/^CCCMD\s*=\s*//;
- $cccmd =~ s/\$\(INC\)/ -I$self->{PERL_INC} /;
- $cccmd .= " $Config::Config{cccdlflags}" if ($Config::Config{d_shrplib});
- $cccmd =~ s/\n/ /g; # yes I've seen "\n", don't ask me where it came from. A.K.
-
- # The front matter of the linkcommand...
- $linkcmd = join ' ', "\$(CC)",
- grep($_, @Config{qw(large split ldflags ccdlflags)});
- $linkcmd =~ s/\s+/ /g;
-
- # Which *.a files could we make use of...
- local(%static);
- File::Find::find(sub {
- return unless m/\Q$self->{LIB_EXT}$/;
- return if m/^libperl/;
- # don't include the installed version of this extension. I
- # leave this line here, although it is not necessary anymore:
- # I patched minimod.PL instead, so that Miniperl.pm won't
- # enclude duplicates
-
- # Once the patch to minimod.PL is in the distribution, I can
- # drop it
- return if $File::Find::name =~ m:auto/$self->{FULLEXT}/$self->{BASEEXT}$self->{LIB_EXT}$:;
- $static{fastcwd() . "/" . $_}++;
- }, grep( -d $_, @{$searchdirs || []}) );
-
- # We trust that what has been handed in as argument, will be buildable
- $static = [] unless $static;
- @static{@{$static}} = (1) x @{$static};
-
- $extra = [] unless $extra && ref $extra eq 'ARRAY';
- for (sort keys %static) {
- next unless /\Q$self->{LIB_EXT}$/;
- $_ = dirname($_) . "/extralibs.ld";
- push @$extra, $_;
- }
+=item FULLPERLRUN
- grep(s/^/-I/, @{$perlinc || []});
+Like PERLRUN, except it uses FULLPERL.
- $target = "perl" unless $target;
- $tmp = "." unless $tmp;
+=item FULLPERLRUNINST
-# MAP_STATIC doesn't look into subdirs yet. Once "all" is made and we
-# regenerate the Makefiles, MAP_STATIC and the dependencies for
-# extralibs.all are computed correctly
- push @m, "
-MAP_LINKCMD = $linkcmd
-MAP_PERLINC = @{$perlinc || []}
-MAP_STATIC = ",
-join(" \\\n\t", reverse sort keys %static), "
+Like PERLRUNINST, except it uses FULLPERL.
-MAP_PRELIBS = $Config::Config{libs} $Config::Config{cryptlib}
-";
+=item FUNCLIST
- if (defined $libperl) {
- ($lperl = $libperl) =~ s/\$\(A\)/$self->{LIB_EXT}/;
- }
- unless ($libperl && -f $lperl) { # Could quite follow your idea her, Ilya
- my $dir = $self->{PERL_SRC} || "$self->{PERL_ARCHLIB}/CORE";
- $libperl ||= "libperl$self->{LIB_EXT}";
- $libperl = "$dir/$libperl";
- $lperl ||= "libperl$self->{LIB_EXT}";
- $lperl = "$dir/$lperl";
- print STDOUT "Warning: $libperl not found
- If you're going to build a static perl binary, make sure perl is installed
- otherwise ignore this warning\n"
- unless (-f $lperl || defined($self->{PERL_SRC}));
- }
+This provides an alternate means to specify function names to be
+exported from the extension. Its value is a reference to an
+array of function names to be exported by the extension. These
+names are passed through unaltered to the linker options file.
- push @m, "
-MAP_LIBPERL = $libperl
-";
+=item H
- push @m, "
-\$(INST_ARCHAUTODIR)/extralibs.all: \$(INST_ARCHAUTODIR)/.exists ".join(" \\\n\t", @$extra)."
- \@ $self->{RM_F} \$\@
- \@ \$(TOUCH) \$\@
-";
+Ref to array of *.h file names. Similar to C.
- my $catfile;
- foreach $catfile (@$extra){
- push @m, "\tcat $catfile >> \$\@\n";
- }
+=item IMPORTS
- push @m, "
-\$(MAP_TARGET) :: $tmp/perlmain\$(OBJ_EXT) \$(MAP_LIBPERL) \$(MAP_STATIC) \$(INST_ARCHAUTODIR)/extralibs.all
- \$(MAP_LINKCMD) -o \$\@ $tmp/perlmain\$(OBJ_EXT) \$(MAP_LIBPERL) \$(MAP_STATIC) `cat \$(INST_ARCHAUTODIR)/extralibs.all` \$(MAP_PRELIBS)
- @ echo 'To install the new \"\$(MAP_TARGET)\" binary, call'
- @ echo ' make -f $makefilename inst_perl MAP_TARGET=\$(MAP_TARGET)'
- @ echo 'To remove the intermediate files say'
- @ echo ' make -f $makefilename map_clean'
-
-$tmp/perlmain\$(OBJ_EXT): $tmp/perlmain.c
-";
- push @m, "\tcd $tmp && $cccmd -I\$(PERL_INC) perlmain.c\n";
-
- push @m, qq{
-$tmp/perlmain.c: $makefilename}, q{
- @ echo Writing $@
- @ $(PERL) $(MAP_PERLINC) -e 'use ExtUtils::Miniperl; \\
- writemain(grep s#.*/auto/##, qw|$(MAP_STATIC)|)' > $@.tmp && mv $@.tmp $@
-
-};
-
-# We write EXTRA outside the perl program to have it eval'd by the shell
- push @m, q{
-doc_inst_perl:
- @ echo Appending installation info to $(INSTALLARCHLIB)/perllocal.pod
- @ $(FULLPERL) -e 'use ExtUtils::MakeMaker; MY->new->writedoc("Perl binary",' \\
- -e '"$(MAP_TARGET)", "MAP_STATIC=$(MAP_STATIC)",' \\
- -e '"MAP_EXTRA=@ARGV", "MAP_LIBPERL=$(MAP_LIBPERL)")' \\
- -- `cat $(INST_ARCHAUTODIR)/extralibs.all` >> $(INSTALLARCHLIB)/perllocal.pod
-};
-
- push @m, qq{
-inst_perl: pure_inst_perl doc_inst_perl
-
-pure_inst_perl: \$(MAP_TARGET)
- $self->{CP} \$(MAP_TARGET) \$(INSTALLBIN)/\$(MAP_TARGET)
-
-clean :: map_clean
-
-map_clean :
- $self->{RM_F} $tmp/perlmain\$(OBJ_EXT) $tmp/perlmain.c \$(MAP_TARGET) $makefilename \$(INST_ARCHAUTODIR)/extralibs.all
-};
-
- join '', @m;
-}
+This attribute is used to specify names to be imported into the
+extension. Takes a hash ref.
-sub extliblist {
- my($self,$libs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- require ExtUtils::Liblist;
- ExtUtils::Liblist::ext($libs, $ExtUtils::MakeMaker::Verbose);
-}
+It is only used on OS/2 and Win32.
-sub mksymlists {
- my($self) = shift;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my($pkg);
+=item INC
- # only AIX requires a symbol list at this point
- # (so does VMS, but that's handled by the MM_VMS package)
- return '' unless $Config::Config{osname} eq 'aix';
+Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
- $self->init_main(@ARGV) unless defined $self->{BASEEXT};
- if (! $self->{DL_FUNCS}) {
- my($bootfunc);
- ($bootfunc = $self->{NAME}) =~ s/\W/_/g;
- $self->{DL_FUNCS} = {$self->{BASEEXT} => ["boot_$bootfunc"]};
- }
- rename "$self->{BASEEXT}.exp", "$self->{BASEEXT}.exp_old";
-
- open(EXP,">$self->{BASEEXT}.exp") or die $!;
- print EXP join("\n",@{$self->{DL_VARS}}, "\n") if $self->{DL_VARS};
- foreach $pkg (keys %{$self->{DL_FUNCS}}) {
- (my($prefix) = $pkg) =~ s/\W/_/g;
- my $func;
- foreach $func (@{$self->{DL_FUNCS}->{$pkg}}) {
- $func = "XS_${prefix}_$func" unless $func =~ /^boot_/;
- print EXP "$func\n";
- }
- }
- close EXP;
-}
+=item INCLUDE_EXT
-# --- Make-Directories section (internal method) ---
-# dir_target(@array) returns a Makefile entry for the file .exists in each
-# named directory. Returns nothing, if the entry has already been processed.
-# We're helpless though, if the same directory comes as $(FOO) _and_ as "bar".
-# Both of them get an entry, that's why we use "::". I chose '$(PERL)' as the
-# prerequisite, because there has to be one, something that doesn't change
-# too often :)
-
-sub dir_target {
- my($self,@dirs) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my(@m,$dir);
- foreach $dir (@dirs) {
- next if $self->{DIR_TARGET}{$self}{$dir}++;
- push @m, "
-$dir/.exists :: \$(PERL)
- \@ \$(MKPATH) $dir
- \@ \$(TOUCH) $dir/.exists
- \@-\$(CHMOD) 755 $dir
-";
- }
- join "", @m;
-}
+Array of extension names to be included when doing a static build.
+MakeMaker will normally build with all of the installed extensions when
+doing a static build, and that is usually the desired behavior. If
+INCLUDE_EXT is present then MakeMaker will build only with those extensions
+which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
-# --- Output postprocessing section ---
-# nicetext is included to make VMS support easier
-sub nicetext { # Just return the input - no action needed
- my($self,$text) = @_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- $text;
-}
+It is not necessary to mention DynaLoader or the current extension when
+filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
+only DynaLoader and the current extension will be included in the build.
-sub needs_linking { # Does this module need linking? Looks into
- # subdirectory objects (see also has_link_code()
- my($self) = shift;
- my($child,$caller);
- $caller = (caller(0))[3];
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse($caller);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- Carp::confess("Needs_linking called too early") if $caller =~ /^ExtUtils::MakeMaker::/;
- return $self->{NEEDS_LINKING} if defined $self->{NEEDS_LINKING};
-# print "DEBUG:\n";
-# print Carp::longmess();
-# print "EO_DEBUG\n";
- if ($self->has_link_code or $self->{MAKEAPERL}){
- $self->{NEEDS_LINKING} = 1;
- return 1;
- }
- foreach $child (keys %{$self->{CHILDREN}}) {
- if ($self->{CHILDREN}->{$child}->needs_linking) {
- $self->{NEEDS_LINKING} = 1;
- return 1;
- }
- }
- return $self->{NEEDS_LINKING} = 0;
-}
+This attribute may be most useful when specified as a string on the
+command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
-sub has_link_code {
- my($self) = shift;
- return $self->{HAS_LINK_CODE} if defined $self->{HAS_LINK_CODE};
- if ($self->{OBJECT} or @{$self->{C} || []} or $self->{MYEXTLIB}){
- $self->{HAS_LINK_CODE} = 1;
- return 1;
- }
- return $self->{HAS_LINK_CODE} = 0;
-}
+=item INSTALLARCHLIB
-# --- perllocal.pod section ---
-sub writedoc {
- my($self,$what,$name,@attribs)=@_;
- unless (ref $self){
- ExtUtils::MakeMaker::TieAtt::warndirectuse((caller(0))[3]);
- $self = $ExtUtils::MakeMaker::Parent[-1];
- }
- my($time);
- require "ctime.pl";
- chop($time = ctime(time));
- print "=head2 $time: $what C<$name>\n\n=over 4\n\n=item *\n\n";
- print join "\n\n=item *\n\n", map("C<$_>",@attribs);
- print "\n\n=back\n\n";
-}
+Used by 'make install', which copies files from INST_ARCHLIB to this
+directory if INSTALLDIRS is set to perl.
-sub catdir { shift; join('/',@_); }
-sub catfile { shift; join('/',@_); }
+=item INSTALLBIN
-package ExtUtils::MM_OS2;
+Directory to install binary files (e.g. tkperl) into if
+INSTALLDIRS=perl.
-#use Config;
-#use Cwd;
-#use File::Basename;
-require Exporter;
+=item INSTALLDIRS
-Exporter::import('ExtUtils::MakeMaker',
- qw( $Verbose));
+Determines which of the sets of installation directories to choose:
+perl, site or vendor. Defaults to site.
-sub dlsyms {
- my($self,%attribs) = @_;
+=item INSTALLMAN1DIR
- my($funcs) = $attribs{DL_FUNCS} || $self->{DL_FUNCS} || {};
- my($vars) = $attribs{DL_VARS} || $self->{DL_VARS} || [];
- my(@m);
- (my $boot = $self->{NAME}) =~ s/:/_/g;
-
- if (not $self->{SKIPHASH}{'dynamic'}) {
- push(@m,"
-$self->{BASEEXT}.def: Makefile.PL"
- . '
- echo "LIBRARY ' . "'$self->{DLBASE}'" . ' INITINSTANCE TERMINSTANCE" > $@ ; \\
- echo "CODE LOADONCALL" >> $@ ; \\
- echo "DATA LOADONCALL NONSHARED MULTIPLE" >> $@ ; \\
- echo "EXPORTS" >> $@ ; \\
- echo " ' . "boot_$boot" . '" >> $@');
- foreach $sym (keys %$funcs, @$vars) {
- push(@m, " ; \\
- echo \" $sym\" >> \$@");
- }
- push(@m,"\n");
- }
+=item INSTALLMAN3DIR
- join('',@m);
-}
+These directories get the man pages at 'make install' time if
+INSTALLDIRS=perl. Defaults to $Config{installman*dir}.
-sub replace_manpage_seperator {
- my($self,$man) = @_;
- $man =~ s,/+,.,g;
- $man;
-}
+If set to 'none', no man pages will be installed.
-sub maybe_command {
- my($self,$file) = @_;
- return 1 if -x $file && ! -d _;
- return 1 if -x "$file.exe" && ! -d _;
- return;
-}
+=item INSTALLPRIVLIB
-# the following keeps AutoSplit happy
-package ExtUtils::MakeMaker;
-1;
+Used by 'make install', which copies files from INST_LIB to this
+directory if INSTALLDIRS is set to perl.
-__END__
+Defaults to $Config{installprivlib}.
-=head1 NAME
+=item INSTALLSCRIPT
-ExtUtils::MakeMaker - create an extension Makefile
+Used by 'make install' which copies files from INST_SCRIPT to this
+directory.
-=head1 SYNOPSIS
+=item INSTALLSITEARCH
-C<use ExtUtils::MakeMaker;>
+Used by 'make install', which copies files from INST_ARCHLIB to this
+directory if INSTALLDIRS is set to site (default).
-C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
+=item INSTALLSITEBIN
-which is really
+Used by 'make install', which copies files from INST_BIN to this
+directory if INSTALLDIRS is set to site (default).
-C<MM-E<gt>new(\%att)-E<gt>flush;>
+=item INSTALLSITELIB
-=head1 DESCRIPTION
+Used by 'make install', which copies files from INST_LIB to this
+directory if INSTALLDIRS is set to site (default).
-This utility is designed to write a Makefile for an extension module
-from a Makefile.PL. It is based on the Makefile.SH model provided by
-Andy Dougherty and the perl5-porters.
+=item INSTALLSITEMAN1DIR
-It splits the task of generating the Makefile into several subroutines
-that can be individually overridden. Each subroutine returns the text
-it wishes to have written to the Makefile.
+=item INSTALLSITEMAN3DIR
-=head2 Hintsfile support
+These directories get the man pages at 'make install' time if
+INSTALLDIRS=site (default). Defaults to
+$(SITEPREFIX)/man/man$(MAN*EXT).
-MakeMaker.pm uses the architecture specific information from
-Config.pm. In addition it evaluates architecture specific hints files
-in a C<hints/> directory. The hints files are expected to be named
-like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
-name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
-MakeMaker within the WriteMakefile() subroutine, and can be used to
-execute commands as well as to include special variables. The rules
-which hintsfile is chosen are the same as in Configure.
+If set to 'none', no man pages will be installed.
-The hintsfile is eval()ed immediately after the arguments given to
-WriteMakefile are stuffed into a hash reference $self but before this
-reference becomes blessed. So if you want to do the equivalent to
-override or create an attribute you would say something like
+=item INSTALLVENDORARCH
- $self->{LIBS} = ['-ldbm -lucb -lc'];
+Used by 'make install', which copies files from INST_ARCHLIB to this
+directory if INSTALLDIRS is set to vendor.
-=head2 What's new in version 5 of MakeMaker
+=item INSTALLVENDORBIN
-MakeMaker 5 is pure object oriented. This allows us to write an
-unlimited number of Makefiles with a single perl process. 'perl
-Makefile.PL' with MakeMaker 5 goes through all subdirectories
-immediately and evaluates any Makefile.PL found in the next level
-subdirectories. The benefit of this approach comes in useful for both
-single and multi directories extensions.
+Used by 'make install', which copies files from INST_BIN to this
+directory if INSTALLDIRS is set to vendor.
-Multi directory extensions have an immediately visible speed
-advantage, because there's no startup penalty for any single
-subdirectory Makefile.
+=item INSTALLVENDORLIB
-Single directory packages benefit from the much improved
-needs_linking() method. As the main Makefile knows everything about
-the subdirectories, a needs_linking() method can now query all
-subdirectories if there is any linking involved down in the tree. The
-speedup for PM-only Makefiles seems to be around 1 second on my
-Indy 100 MHz.
+Used by 'make install', which copies files from INST_LIB to this
+directory if INSTALLDIRS is set to vendor.
-=head2 Incompatibilities between MakeMaker 5.00 and 4.23
+=item INSTALLVENDORMAN1DIR
-There are no incompatibilities in the short term, as all changes are
-accompanied by short-term workarounds that guarantee full backwards
-compatibility.
+=item INSTALLVENDORMAN3DIR
-You are likely to face a few warnings that expose deprecations which
-will result in incompatibilities in the long run:
+These directories get the man pages at 'make install' time if
+INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT).
-You should not use %att directly anymore. Instead any subroutine you
-override in the MY package will be called by the object method, so you
-can access all object attributes directly via the object in $_[0].
+If set to 'none', no man pages will be installed.
-You should not call the class methos MM->something anymore. Instead
-you should call the superclass. Something like
+=item INST_ARCHLIB
- sub MY::constants {
- my $self = shift;
- local *constants;
- $self->MM::constants();
- }
+Same as INST_LIB for architecture dependent files.
-Especially the libscan() and exescan() methods should be altered
-towards OO programming, that means do not expect that $_ to contain
-the path but rather $_[1].
+=item INST_BIN
-You should program with more care. Watch out for any MakeMaker
-variables. Do not try to alter them, somebody else might depend on
-them. E.g. do not overwrite the ExtUtils::MakeMaker::VERSION variable
-(this happens if you import it and then set it to the version number
-of your package), do not expect that the INST_LIB variable will be
-./blib (do not 'unshift @INC, "./blib" and do not use
-"blib/FindBin.pm"). Do not croak in your Makefile.PL, let it fail with
-a warning instead.
+Directory to put real binary files during 'make'. These will be copied
+to INSTALLBIN during 'make install'
-Try to build several extensions simultanously to debug your
-Makefile.PL. You can unpack a bunch of distributed packages, so your
-directory looks like
+=item INST_LIB
- Alias-1.00/ Net-FTP-1.01a/ Set-Scalar-0.001/
- ExtUtils-Peek-0.4/ Net-Ping-1.00/ SetDualVar-1.0/
- Filter-1.06/ NetTools-1.01a/ Storable-0.1/
- GD-1.00/ Religion-1.04/ Sys-Domain-1.05/
- MailTools-1.03/ SNMP-1.5b/ Term-ReadLine-0.7/
+Directory where we put library files of this extension while building
+it.
-and write a dummy Makefile.PL that contains nothing but
+=item INST_MAN1DIR
- use ExtUtils::MakeMaker;
- WriteMakefile();
+Directory to hold the man pages at 'make' time
-That's actually fun to watch :)
+=item INST_MAN3DIR
-Final suggestion: Try to delete all of your MY:: subroutines and
-watch, if you really still need them. MakeMaker might already do what
-you want without them. That's all about it.
+Directory to hold the man pages at 'make' time
+=item INST_SCRIPT
-=head2 Default Makefile Behaviour
+Directory, where executable files should be installed during
+'make'. Defaults to "./blib/script", just to have a dummy location during
+testing. make install will copy the files in INST_SCRIPT to
+INSTALLSCRIPT.
-The automatically generated Makefile enables the user of the extension
-to invoke
+=item LD
- perl Makefile.PL # optionally "perl Makefile.PL verbose"
- make
- make test # optionally set TEST_VERBOSE=1
- make install # See below
+Program to be used to link libraries for dynamic loading.
-The Makefile to be produced may be altered by adding arguments of the
-form C<KEY=VALUE>. If the user wants to work with a different perl
-than the default, this can be achieved with
+Defaults to $Config{ld}.
- perl Makefile.PL PERL=/tmp/myperl5
+=item LDDLFLAGS
-Other interesting targets in the generated Makefile are
+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<Config/lddlflags>)
- make config # to check if the Makefile is up-to-date
- make clean # delete local temp files (Makefile gets renamed)
- make realclean # delete derived files (including ./blib)
- make dist # see below the Distribution Support section
+Defaults to $Config{lddlflags}.
-=head2 Special case make install
+=item LDFROM
-make alone puts all relevant files into directories that are named by
-the macros INST_LIB, INST_ARCHLIB, INST_EXE, INST_MAN1DIR, and
-INST_MAN3DIR. All these default to ./blib or something below blib if
-you are I<not> building below the perl source directory. If you I<are>
-building below the perl source, INST_LIB and INST_ARCHLIB default to
- ../../lib, and INST_EXE is not defined.
+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)
-The I<install> target of the generated Makefile is a recursive call to
-make which sets
+=item LIB
- INST_LIB to INSTALLPRIVLIB
- INST_ARCHLIB to INSTALLARCHLIB
- INST_EXE to INSTALLBIN
- INST_MAN1DIR to INSTALLMAN1DIR
- INST_MAN3DIR to INSTALLMAN3DIR
+LIB should only be set at C<perl Makefile.PL> time but is allowed as a
+MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
+and INSTALLSITELIB to that value regardless any explicit setting of
+those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
+are set to the corresponding architecture subdirectory.
-The INSTALL... macros in turn default to their %Config
-($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
+=item LIBPERL_A
-The recommended way to proceed is to set only the INSTALL* macros, not
-the INST_* targets. In doing so, you give room to the compilation
-process without affecting important directories. Usually a make
-test will succeed after the make, and a make install can finish
-the game.
+The filename of the perllibrary that will be used together with this
+extension. Defaults to libperl.a.
-MakeMaker gives you much more freedom than needed to configure
-internal variables and get different results. It is worth to mention,
-that make(1) also lets you configure most of the variables that are
-used in the Makefile. But in the majority of situations this will not
-be necessary, and should only be done, if the author of a package
-recommends it.
+=item LIBS
-The usual relationship between INSTALLPRIVLIB and INSTALLARCHLIB is
-that the latter is a subdirectory of the former with the name
-C<$Config{archname}>, MakeMaker supports the user who sets
-INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not, then
-MakeMaker defaults the latter to be INSTALLPRIVLIB/ARCHNAME if that
-directory exists, otherwise it defaults to INSTALLPRIVLIB.
+An anonymous array of alternative library
+specifications to be searched for (in order) until
+at least one library is found. E.g.
+ 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
-=head2 PREFIX attribute
+Mind, that any element of the array
+contains a complete set of arguments for the ld
+command. So do not specify
-The PREFIX attribute can be used to set the INSTALL*
-attributes in one go. This is the quickest way to install a module in
-a non-standard place.
+ 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
- perl Makefile.PL PREFIX=~
+See ODBM_File/Makefile.PL for an example, where an array is needed. If
+you specify a scalar as in
-This is identical to
+ 'LIBS' => "-ltcl -ltk -lX11"
- perl Makefile.PL INSTALLPRIVLIB=~/perl5/lib INSTALLBIN=~/bin \
- INSTAMAN1DIR=~/perl5/man/man1 INSTALLMAN3DIR=~/perl5/man/man3
+MakeMaker will turn it into an array with one element.
-Note, that the tilde expansion is done by MakeMaker, not by perl by
-default, nor by make.
+=item LINKTYPE
-It is important to know, that the INSTALL* macros should be absolute
-paths, never relativ ones. Packages with multiple Makefile.PLs in
-different directories get the contents of the INSTALL* macros
-propagated verbatim. (The INST_* macros will be corrected, if they are
-relativ paths, but not the INSTALL* macros.)
+'static' or 'dynamic' (default unless usedl=undef in
+config.sh). Should only be used to force static linking (also see
+linkext below).
-If the user has superuser privileges, and is not working on AFS
-(Andrew File System) or relatives, then the defaults for
-INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLBIN, etc. will be appropriate,
-and this incantation will be the best:
+=item MAKEAPERL
- perl Makefile.PL; make; make test
- make install
+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.
-make install per default writes some documentation of what has been
-done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This is
-an experimental feature. It can be bypassed by calling make
-pure_install.
+=item MAKEFILE_OLD
-=head2 AFS users
+When 'make clean' or similar is run, the $(FIRST_MAKEFILE) will be
+backed up at this location.
-will have to specify the installation directories as these most
-probably have changed since perl itself has been installed. They will
-have to do this by calling
+Defaults to $(FIRST_MAKEFILE).old or $(FIRST_MAKEFILE)_old on VMS.
- perl Makefile.PL INSTALLPRIVLIB=/afs/here/today \
- INSTALLBIN=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
- make
+=item MAN1PODS
-In nested extensions with many subdirectories, the INSTALL* arguments
-will get propagated to the subdirectories. Be careful to repeat this
-procedure every time you recompile an extension, unless you are sure
-the AFS istallation directories are still valid.
+Hashref of pod-containing files. MakeMaker will default this to all
+EXE_FILES files that include POD directives. The files listed
+here will be converted to man pages and installed as was requested
+at Configure time.
+=item MAN3PODS
+Hashref that assigns to *.pm and *.pod files the files into which the
+manpages are to be written. MakeMaker parses all *.pod and *.pm files
+for POD directives. Files that contain POD will be the default keys of
+the MAN3PODS hashref. These will then be converted to man pages during
+C<make> and will be installed during C<make install>.
-=head2 Static Linking of a new Perl Binary
+=item MAP_TARGET
-An extension that is built with the above steps is ready to use on
-systems supporting dynamic loading. On systems that do not support
-dynamic loading, any newly created extension has to be linked together
-with the available resources. MakeMaker supports the linking process
-by creating appropriate targets in the Makefile whenever an extension
-is built. You can invoke the corresponding section of the makefile with
+If it is intended, that a new perl binary be produced, this variable
+may hold a name for that binary. Defaults to perl
- make perl
+=item MYEXTLIB
-That produces a new perl binary in the current directory with all
-extensions linked in that can be found in INST_ARCHLIB (which usually
-is C<./blib>) and PERL_ARCHLIB. To do that, MakeMaker writes a new
-Makefile, on UNIX, this is called Makefile.aperl (may be system
-dependent). If you want to force the creation of a new perl, it is
-recommended, that you delete this Makefile.aperl, so INST_ARCHLIB and
-PERL_ARCHLIB are searched-through for linkable libraries again.
+If the extension links to a library that it builds set this to the
+name of the library (see SDBM_File)
-The binary can be installed into the directory where perl normally
-resides on your machine with
+=item NAME
- make inst_perl
+Perl module name for this extension (DBD::Oracle). This will default
+to the directory name but should be explicitly defined in the
+Makefile.PL.
-To produce a perl binary with a different name than C<perl>, either say
+=item NEEDS_LINKING
- perl Makefile.PL MAP_TARGET=myperl
- make myperl
- make inst_perl
+MakeMaker will figure out if an extension contains linkable code
+anywhere down the directory tree, and will set this variable
+accordingly, but you can speed it up a very little bit if you define
+this boolean variable yourself.
-or say
+=item NOECHO
- perl Makefile.PL
- make myperl MAP_TARGET=myperl
- make inst_perl MAP_TARGET=myperl
+Command so make does not print the literal commands its running.
-In any case you will be prompted with the correct invocation of the
-C<inst_perl> target that installs the new binary into INSTALLBIN.
+By setting it to an empty string you can generate a Makefile that
+prints all commands. Mainly used in debugging MakeMaker itself.
-Note, that there is a C<makeaperl> scipt in the perl distribution,
-that supports the linking of a new perl binary in a similar fashion,
-but with more options.
+Defaults to C<@>.
-make inst_perl per default writes some documentation of what has been
-done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
-can be bypassed by calling make pure_inst_perl.
+=item NORECURS
-Warning: the inst_perl: target is rather mighty and will probably
-overwrite your existing perl binary. Use with care!
+Boolean. Attribute to inhibit descending into subdirectories.
-Sometimes you might want to build a statically linked perl although
-your system supports dynamic loading. In this case you may explicitly
-set the linktype with the invocation of the Makefile.PL or make:
+=item NO_META
- perl Makefile.PL LINKTYPE=static # recommended
+When true, suppresses the generation and addition to the MANIFEST of
+the META.yml module meta-data file during 'make distdir'.
-or
+Defaults to false.
- make LINKTYPE=static # works on most systems
+=item NO_VC
-=head2 Determination of Perl Library and Installation Locations
+In general, any generated Makefile checks for the current version of
+MakeMaker and the version the Makefile was built under. If NO_VC is
+set, the version check is neglected. Do not write this into your
+Makefile.PL, use it interactively instead.
-MakeMaker needs to know, or to guess, where certain things are
-located. Especially INST_LIB and INST_ARCHLIB (where to install files
-into), PERL_LIB and PERL_ARCHLIB (where to read existing modules
-from), and PERL_INC (header files and C<libperl*.*>).
+=item OBJECT
-Extensions may be built either using the contents of the perl source
-directory tree or from an installed copy of the perl library.
+List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
+string containing all object files, e.g. "tkpBind.o
+tkpButton.o tkpCanvas.o"
-If an extension is being built below the C<ext/> directory of the perl
-source then MakeMaker will set PERL_SRC automatically (e.g., C<../..>).
-If PERL_SRC is defined then other variables default to the following:
+(Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
- PERL_INC = PERL_SRC
- PERL_LIB = PERL_SRC/lib
- PERL_ARCHLIB = PERL_SRC/lib
- INST_LIB = PERL_LIB
- INST_ARCHLIB = PERL_ARCHLIB
+=item OPTIMIZE
-If an extension is being built away from the perl source then MakeMaker
-will leave PERL_SRC undefined and default to using the installed copy
-of the perl library. The other variables default to the following:
+Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
+passed to subdirectory makes.
- PERL_INC = $archlib/CORE
- PERL_LIB = $privlib
- PERL_ARCHLIB = $archlib
- INST_LIB = ./blib
- INST_ARCHLIB = ./blib/<archname>
+=item PERL
-If perl has not yet been installed then PERL_SRC can be defined on the
-command line as shown in the previous section.
+Perl binary for tasks that can be done by miniperl
-=head2 Useful Default Makefile Macros
+=item PERL_CORE
-FULLEXT = Pathname for extension directory (eg DBD/Oracle).
+Set only when MakeMaker is building the extensions of the Perl core
+distribution.
-BASEEXT = Basename part of FULLEXT. May be just equal FULLEXT.
+=item PERLMAINCC
-ROOTEXT = Directory part of FULLEXT with leading slash (eg /DBD)
+The call to the program that is able to compile perlmain.c. Defaults
+to $(CC).
-INST_LIBDIR = C<$(INST_LIB)$(ROOTEXT)>
+=item PERL_ARCHLIB
-INST_AUTODIR = C<$(INST_LIB)/auto/$(FULLEXT)>
+Same as for PERL_LIB, but for architecture dependent files.
-INST_ARCHAUTODIR = C<$(INST_ARCHLIB)/auto/$(FULLEXT)>
+Used only when MakeMaker is building the extensions of the Perl core
+distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
+and adding it would get in the way of PERL5LIB).
-=head2 Using Attributes (and Parameters)
+=item PERL_LIB
-The following attributes can be specified as arguments to WriteMakefile()
-or as NAME=VALUE pairs on the command line:
+Directory containing the Perl library to use.
-=cut
+Used only when MakeMaker is building the extensions of the Perl core
+distribution (because normally $(PERL_LIB) is automatically in @INC,
+and adding it would get in the way of PERL5LIB).
-# The following "=item NAME" is used by the attrib_help routine
-# likewise the "=back" below. So be careful when changing it!
+=item PERL_MALLOC_OK
-=over 2
+defaults to 0. Should be set to TRUE if the extension can work with
+the memory allocation routines substituted by the Perl malloc() subsystem.
+This should be applicable to most extensions with exceptions of those
-=item NAME
+=over 4
-Perl module name for this extension (DBD::Oracle). This will default
-to the directory name but should be explicitly defined in the
-Makefile.PL.
+=item *
-=item DISTNAME
+with bugs in memory allocations which are caught by Perl's malloc();
-Your name for distributing the package (by tar file) This defaults to
-NAME above.
+=item *
-=item VERSION
+which interact with the memory allocator in other ways than via
+malloc(), realloc(), free(), calloc(), sbrk() and brk();
-Your version number for distributing the package. This defaults to
-0.1.
+=item *
-=item CONFIGURE
+which rely on special alignment which is not provided by Perl's malloc().
-CODE reference. Extension writers are requested to do all their
-initializing within that subroutine. The subroutine
-should return a hash reference. The hash may contain
-further attributes, e.g. {LIBS => ...}, that have to
-be determined by some evaluation method.
+=back
-=item NEEDS_LINKING
+B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
+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.
-MakeMaker will figure out, if an extension contains linkable code
-anywhere down the directory tree, but you can speed him up a little
-bit, if you define this boolean variable yourself. Extensions that do
-not need linking will be given a reduced Makefile yielding a
-considerable speedadvantage.
+=item PERLPREFIX
-=item INST_LIB
+Directory under which core modules are to be installed.
-Directory where we put library files of this extension while building
-it.
+Defaults to $Config{installprefixexp} falling back to
+$Config{installprefix}, $Config{prefixexp} or $Config{prefix} should
+$Config{installprefixexp} not exist.
-=item INSTALLPRIVLIB
+Overridden by PREFIX.
-Used by 'make install', which sets INST_LIB to this value.
+=item PERLRUN
-=item INST_ARCHLIB
+Use this instead of $(PERL) when you wish to run perl. It will set up
+extra necessary flags for you.
-Same as INST_LIB for architecture dependent files.
+=item PERLRUNINST
-=item INSTALLARCHLIB
+Use this instead of $(PERL) when you wish to run perl to work with
+modules. It will add things like -I$(INST_ARCH) and other necessary
+flags so perl can see the modules you're about to install.
-Used by 'make install', which sets INST_ARCHLIB to this value.
+=item PERL_SRC
-=item INST_EXE
+Directory containing the Perl source code (use of this should be
+avoided, it may be undefined)
-Directory, where executable scripts should be installed during
-'make'. Defaults to "./blib/ARCHNAME", just to have a dummy
-location during testing. make install will set
-INST_EXE to INSTALLBIN.
+=item PERM_RW
-=item INSTALLBIN
+Desired permission for read/writable files. Defaults to C<644>.
+See also L<MM_Unix/perm_rw>.
-Used by 'make install' which sets INST_EXE to this value.
+=item PERM_RWX
-=item INST_MAN1DIR
+Desired permission for executable files. Defaults to C<755>.
+See also L<MM_Unix/perm_rwx>.
-=item INST_MAN3DIR
+=item PL_FILES
-These directories get the man pages at 'make' time
+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.
-=item INSTALLMAN1DIR
+ {'foobar.PL' => 'foobar'}
-=item INSTALLMAN3DIR
+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.
-These directories get the man pages at 'make install' time
+ {'foobar.PL' => ['foobar1','foobar2']}
-=item PREFIX
+=item PM
-Can be used to set the three INSTALL* attributes above in one go.
-They will have PREFIX as a common directory node and
-will branch from that node into lib/, lib/ARCHNAME,
-and bin/ unless you override one of them.
+Hashref of .pm files and *.pl files to be installed. e.g.
-=item PERL_LIB
+ {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
-Directory containing the Perl library to use.
+By default this will include *.pm and *.pl and the files found in
+the PMLIBDIRS directories. Defining PM in the
+Makefile.PL will override PMLIBDIRS.
-=item PERL_ARCHLIB
+=item PMLIBDIRS
-Same as above for architecture dependent files
+Ref to array of subdirectories containing library files. Defaults to
+[ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
+they contain will be installed in the corresponding location in the
+library. A libscan() method can be used to alter the behaviour.
+Defining PM in the Makefile.PL will override PMLIBDIRS.
-=item PERL_SRC
+(Where BASEEXT is the last component of NAME.)
-Directory containing the Perl source code (use of this should be
-avoided, it may be undefined)
+=item PM_FILTER
-=item INC
+A filter program, in the traditional Unix sense (input from stdin, output
+to stdout) that is passed on each .pm file during the build (in the
+pm_to_blib() phase). It is empty by default, meaning no filtering is done.
-Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
+Great care is necessary when defining the command if quoting needs to be
+done. For instance, you would need to say:
-=item DEFINE
+ {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
-Something like C<"-DHAVE_UNISTD_H">
+to remove all the leading coments 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
+# is escaped for the Makefile, since what is going to be generated will then
+be:
-=item OBJECT
+ PM_FILTER = grep -v \"^\#\"
-List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
-string containing all object files, e.g. "tkpBind.o
-tkpButton.o tkpCanvas.o"
+Without the \\ before the #, we'd have the start of a Makefile comment,
+and the macro would be incorrectly defined.
-=item MYEXTLIB
+=item POLLUTE
-If the extension links to a library that it builds set this to the
-name of the library (see SDBM_File)
+Release 5.005 grandfathered old global symbol names by providing preprocessor
+macros for extension source compatibility. As of release 5.6, these
+preprocessor definitions are not available by default. The POLLUTE flag
+specifies that the old names should still be defined:
-=item LIBS
+ perl Makefile.PL POLLUTE=1
-An anonymous array of alternative library
-specifications to be searched for (in order) until
-at least one library is found. E.g.
+Please inform the module author if this is necessary to successfully install
+a module under 5.6 or later.
- 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
+=item PPM_INSTALL_EXEC
-Mind, that any element of the array
-contains a complete set of arguments for the ld
-command. So do not specify
+Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
- 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
+=item PPM_INSTALL_SCRIPT
-See ODBM_File/Makefile.PL for an example, where an array is needed. If
-you specify a scalar as in
+Name of the script that gets executed by the Perl Package Manager after
+the installation of a package.
- 'LIBS' => "-ltcl -ltk -lX11"
+=item PREFIX
-MakeMaker will turn it into an array with one element.
+This overrides all the default install locations. Man pages,
+libraries, scripts, etc... MakeMaker will try to make an educated
+guess about where to place things under the new PREFIX based on your
+Config defaults. Failing that, it will fall back to a structure
+which should be sensible for your platform.
-=item LDFROM
+If you specify LIB or any INSTALL* variables they will not be effected
+by the PREFIX.
-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)
+=item PREREQ_FATAL
-=item DIR
+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.
-Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
-] in ext/SDBM_File
+Note: see L<Test::Harness> for a shortcut for stopping tests early if
+you are missing dependencies.
-=item PMLIBDIRS
+Do I<not> use this parameter for simple requirements, which could be resolved
+at a later time, e.g. after an unsuccessful B<make test> of your module.
-Ref to array of subdirectories containing library files. Defaults to
-[ 'lib', $(BASEEXT) ]. The directories will be scanned and any files
-they contain will be installed in the corresponding location in the
-library. A libscan() method can be used to alter the behaviour.
-Defining PM in the Makefile.PL will override PMLIBDIRS.
+It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
-=item PM
+=item PREREQ_PM
-Hashref of .pm files and *.pl files to be installed. e.g.
+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.
- {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
+=item PREREQ_PRINT
-By default this will include *.pm and *.pl. If a lib directory
-exists and is not listed in DIR (above) then any *.pm and *.pl files
-it contains will also be included by default. Defining PM in the
-Makefile.PL will override PMLIBDIRS.
+Bool. If this parameter is true, the prerequisites will be printed to
+stdout and MakeMaker will exit. The output format is an evalable hash
+ref.
-=item XS
+$PREREQ_PM = {
+ 'A::B' => Vers1,
+ 'C::D' => Vers2,
+ ...
+ };
-Hashref of .xs files. MakeMaker will default this. e.g.
+=item PRINT_PREREQ
- {'name_of_file.xs' => 'name_of_file.c'}
+RedHatism for C<PREREQ_PRINT>. The output format is different, though:
-The .c files will automatically be included in the list of files
-deleted by a make clean.
+ perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
-=item XSOPT
+=item SITEPREFIX
-String of options to pass to xsubpp. This might include C<-C++> or
-C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
-that purpose.
+Like PERLPREFIX, but only for the site install locations.
-=item C
+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.
-Ref to array of *.c file names. Initialised from a directory scan
-and the values portion of the XS attribute hash. This is not
-currently used by MakeMaker but may be handy in Makefile.PLs.
+Overridable by PREFIX
-=item H
+=item SKIP
-Ref to array of *.h file names. Similar to C above.
+Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
+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 TYPEMAPS
precedence, even if it isn't listed in TYPEMAPS. The default system
typemap has lowest precedence.
-=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.
-
- {'foobar.PL' => 'foobar'}
-
-The *.PL files are expected to produce output to the target files
-themselves.
+=item VENDORPREFIX
-=item EXE_FILES
+Like PERLPREFIX, but only for the vendor install locations.
-Ref to array of executable files. The files will be copied to the
-INST_EXE directory. Make realclean will delete them from there
-again.
+Defaults to $Config{vendorprefixexp}.
-=item LINKTYPE
+Overridable by PREFIX
-'static' or 'dynamic' (default unless usedl=undef in config.sh) Should
-only be used to force static linking (also see
-linkext below).
+=item VERBINST
-=item DL_FUNCS
+If true, make install will be verbose
-Hashref of symbol names for routines to be made available as
-universal symbols. Each key/value pair consists of the package name
-and an array of routine names in that package. Used only under AIX
-(export lists) and VMS (linker options) at present. The routine
-names supplied will be expanded in the same way as XSUB names are
-expanded by the XS() macro. Defaults to
+=item VERSION
- {"$(NAME)" => ["boot_$(NAME)" ] }
+Your version number for distributing the package. This defaults to
+0.1.
-e.g.
+=item VERSION_FROM
- {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
- "NetconfigPtr" => [ 'DESTROY'] }
+Instead of specifying the VERSION in the Makefile.PL you can let
+MakeMaker parse a file to determine the version number. The parsing
+routine requires that the file named by VERSION_FROM contains one
+single line to compute the version number. The first line in the file
+that contains the regular expression
-=item DL_VARS
+ /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
-Array of symbol names for variables to be made available as
-universal symbols. Used only under AIX (export lists) and VMS
-(linker options) at present. Defaults to []. (e.g. [ qw(
-Foo_version Foo_numstreams Foo_tree ) ])
+will be evaluated with eval() and the value of the named variable
+B<after> the eval() will be assigned to the VERSION attribute of the
+MakeMaker object. The following lines will be parsed o.k.:
-=item CONFIG
+ $VERSION = '1.00';
+ *VERSION = \'1.01';
+ $VERSION = sprintf "%d.%03d", q$Revision: 1.131 $ =~ /(\d+)/g;
+ $FOO::VERSION = '1.10';
+ *FOO::VERSION = \'1.11';
+ our $VERSION = 1.2.3; # new for perl5.6.0
-Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
-config.sh
+but these will fail:
-=item SKIP
+ my $VERSION = '1.01';
+ local $VERSION = '1.02';
+ local $FOO::VERSION = '1.30';
-Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
-Makefile
+(Putting C<my> or C<local> on the preceding line will work o.k.)
-=item MAP_TARGET
+The file named in VERSION_FROM is not added as a dependency to
+Makefile. This is not really correct, but it would be a major pain
+during development to have to rewrite the Makefile for any smallish
+change in that file. If you want to make sure that the Makefile
+contains the correct VERSION macro after any change of the file, you
+would have to do something like
-If it is intended, that a new perl binary be produced, this variable
-may hold a name for that binary. Defaults to perl
+ depend => { Makefile => '$(VERSION_FROM)' }
-=item LIBPERL_A
+See attribute C<depend> below.
-The filename of the perllibrary that will be used together with this
-extension. Defaults to libperl.a.
+=item VERSION_SYM
-=item PERL
+A sanitized VERSION with . replaced by _. For places where . has
+special meaning (some filesystems, RCS labels, etc...)
-Perl binary for tasks that can be done by miniperl
+=item XS
-=item FULLPERL
+Hashref of .xs files. MakeMaker will default this. e.g.
-Perl binary able to run this extension.
+ {'name_of_file.xs' => 'name_of_file.c'}
-=item PREREQ
+The .c files will automatically be included in the list of files
+deleted by a make clean.
-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. (Not yet implemented!)
+=item XSOPT
-=item NORECURS
+String of options to pass to xsubpp. This might include C<-C++> or
+C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
+that purpose.
-Boolean. Experimental attribute to inhibit descending into
-subdirectories.
+=item XSPROTOARG
-=item MANPODS
+May be set to an empty string, which is identical to C<-prototypes>, or
+C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
+defaults to the empty string.
-Hashref of .pm and .pod files. MakeMaker will default this to all
-.pod and any .pm files that include POD directives. The files listed
-here will be converted to man pages and installed as was requested
-at Configure time.
+=item XS_VERSION
-=item MAKEAPERL
+Your version number for the .xs file of this package. This defaults
+to the value of the VERSION attribute.
-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.
+=back
-=item FIRST_MAKEFILE
+=head2 Additional lowercase attributes
-=item MAKEFILE
+can be used to pass parameters to the methods which implement that
+part of the Makefile. Parameters are specified as a hash ref but are
+passed to the method as a hash.
-The name of the Makefile to be produced.
+=over 2
-=item PERLMAINCC
+=item clean
-The call to the program that is able to compile perlmain.c. Defaults
-to $(CC).
+ {FILES => "*.xyz foo"}
-=back
+=item depend
-=head2 Additional lowercase attributes
+ {ANY_TARGET => ANY_DEPENDECY, ...}
-can be used to pass parameters to the methods which implement that
-part of the Makefile. These are not normally required:
+(ANY_TARGET must not be given a double-colon rule by MakeMaker.)
-=over 2
+=item dist
-=item macro
+ {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
+ SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
+ ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
- {ANY_MACRO => ANY_VALUE, ...}
+If you specify COMPRESS, then SUFFIX should also be altered, as it is
+needed to tell make the target file of the compression. Setting
+DIST_CP to ln can be useful, if you need to preserve the timestamps on
+your files. DIST_CP can take the values 'cp', which copies the file,
+'ln', which links the file, and 'best' which copies symbolic links and
+links the rest. Default is 'best'.
-=item installpm
+=item dynamic_lib
- {SPLITLIB => '$(INST_LIB)' (default) or '$(INST_ARCHLIB)'}
+ {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
=item linkext
{LINKTYPE => 'static', 'dynamic' or ''}
-NB: Extensions that have nothing but *.pm files or have the role of
-holding together several subdirectories specify
+NB: Extensions that have nothing but *.pm files had to say
{LINKTYPE => ''}
-=item dynamic_lib
+with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
+can be deleted safely. MakeMaker recognizes when there's nothing to
+be linked.
- {ARMAYBE => 'ar', OTHERLDFLAGS => '...'}
+=item macro
-=item clean
+ {ANY_MACRO => ANY_VALUE, ...}
- {FILES => "*.xyz foo"}
+=item postamble
+
+Anything put here will be passed to MY::postamble() if you have one.
=item realclean
{FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
-=item dist
-
- {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => 'gz',
- SHAR => 'shar -m', DIST_CP => 'ln'}
+=item test
-If you specify COMPRESS, then SUFFIX should also be altered, as it is
-needed to tell make the target file of the compression. Setting
-DIST_CP to ln can be useful, if you need to preserve the timestamps on
-your files. DIST_CP can take the values 'cp', which copies the file,
-'ln', which links the file, and 'best' which copies symbolic links and
-links the rest. Default is 'best'.
+ {TESTS => 't/*.t'}
=item tool_autosplit
- {MAXLEN =E<gt> 8}
+ {MAXLEN => 8}
=back
-=cut
-
-# bug in pod2html, so leave the =back
-
-# Don't delete this cut, MM depends on it!
-
=head2 Overriding MakeMaker Methods
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:
- sub MY::c_o { "new literal text" }
+ sub MY::c_o { "new literal text" }
or you can edit the default by saying something like:
- sub MY::c_o {
- my $self = shift;
- local *c_o;
- $_=$self->MM::c_o;
- s/old text/new text/;
- $_;
- }
+ package MY; # so that "SUPER" works right
+ sub c_o {
+ my $inherited = shift->SUPER::c_o(@_);
+ $inherited =~ s/old text/new text/;
+ $inherited;
+ }
-Both methods above are available for backwards compatibility with
-older Makefile.PLs.
+If you are running experiments with embedding perl as a library into
+other applications, you might find MakeMaker is not sufficient. You'd
+better have a look at ExtUtils::Embed which is a collection of utilities
+for embedding.
If you still need a different solution, try to develop another
-subroutine, that fits your needs and submit the diffs to
-F<perl5-porters@nicoh.com> or F<comp.lang.perl.misc> as appropriate.
+subroutine that fits your needs and submit the diffs to
+F<makemaker@perl.org>
+
+For a complete description of all MakeMaker methods see
+L<ExtUtils::MM_Unix>.
+
+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 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<<MAN3PODS => { }>>.
+
+=back
+
+
+=head2 Hintsfile support
+
+MakeMaker.pm uses the architecture specific information from
+Config.pm. In addition it evaluates architecture specific hints files
+in a C<hints/> directory. The hints files are expected to be named
+like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
+name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
+MakeMaker within the WriteMakefile() subroutine, and can be used to
+execute commands as well as to include special variables. The rules
+which hintsfile is chosen are the same as in Configure.
+
+The hintsfile is eval()ed immediately after the arguments given to
+WriteMakefile are stuffed into a hash reference $self but before this
+reference becomes blessed. So if you want to do the equivalent to
+override or create an attribute you would say something like
+
+ $self->{LIBS} = ['-ldbm -lucb -lc'];
=head2 Distribution Support
=item make distclean
does a realclean first and then the distcheck. Note that this is not
-needed to build a new distribution as long as you are sure, that the
+needed to build a new distribution as long as you are sure that the
MANIFEST file is ok.
=item make manifest
directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
exists, it will be removed first.
-=item make disttest
+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<perl Makefile.PL>, a make, and
a make test in that directory.
=item make tardist
-First does a command $(PREOP) which defaults to a null command. Does a
-distdir next and runs C<tar> on that directory into a tarfile. Then
-deletes the distdir. Finishes with a command $(POSTOP) which defaults
-to a null command.
+First does a distdir. Then a command $(PREOP) which defaults to a null
+command, followed by $(TOUNIX), which defaults to a null command under
+UNIX, and will convert files in distribution directory to UNIX format
+otherwise. Next it runs C<tar> on that directory into a tarfile and
+deletes the directory. Finishes with a command $(POSTOP) which
+defaults to a null command.
=item make dist
=item make shdist
-First does a command $(PREOP) which defaults to a null command. Does a
-distdir next and runs C<shar> on that directory into a sharfile. Then
-deletes the distdir. Finishes with a command $(POSTOP) which defaults
-to a null command. Note: For shdist to work properly a C<shar>
-program that can handle directories is mandatory.
+First does a distdir. Then a command $(PREOP) which defaults to a null
+command. Next it runs C<shar> on that directory into a sharfile and
+deletes the intermediate directory again. Finishes with a command
+$(POSTOP) which defaults to a null command. Note: For shdist to work
+properly a C<shar> program that can handle directories is mandatory.
+
+=item make zipdist
+
+First does a distdir. Then a command $(PREOP) which defaults to a null
+command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
+zipfile. Then deletes that directory. Finishes with a command
+$(POSTOP) which defaults to a null command.
=item make ci
following parameters are recognized:
CI ('ci -u')
- COMPRESS ('compress')
+ COMPRESS ('gzip --best')
POSTOP ('@ :')
PREOP ('@ :')
+ TO_UNIX (depends on the system)
RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
SHAR ('shar')
- SUFFIX ('Z')
+ SUFFIX ('.gz')
TAR ('tar')
TARFLAGS ('cvf')
+ ZIP ('zip')
+ ZIPFLAGS ('-r')
An example:
- WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" })
+ 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<without> running the F<Makefile.PL> and doing a bunch of messy
+heuristics on the resulting F<Makefile>. To this end a simple module
+meta-data file has been introduced, F<META.yml>.
+
+F<META.yml> 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<META.yml> file for you and
+add it to your F<MANIFEST> 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<NO_META> C<WriteMakefile()> flag to true.
+
+
+=head2 Disabling an extension
+
+If some events detected in F<Makefile.PL> imply that there is no way
+to create the Module, but this is a normal state of things, then you
+can create a F<Makefile> which does nothing, but succeeds on all the
+"usual" build targets. To do so, use
+
+ ExtUtils::MakeMaker::WriteEmptyMakefile();
+
+instead of WriteMakefile().
+
+This may be useful if other modules expect this module to be I<built>
+OK, as opposed to I<work> OK (say, this system-dependent module builds
+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<prompt()> 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<prompt()> 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 4
+
+=item PERL_MM_OPT
+
+Command line options used by C<MakeMaker-E<gt>new()>, and thus by
+C<WriteMakefile()>. The string is split on whitespace, and the result
+is processed before any actual command line arguments are processed.
+
+=item PERL_MM_USE_DEFAULT
+
+If set to a true value then MakeMaker's prompt function will
+always return the default without waiting for user input.
+
+=back
+
+=head1 SEE ALSO
+
+ExtUtils::MM_Unix, ExtUtils::Manifest ExtUtils::Install,
+ExtUtils::Embed
=head1 AUTHORS
-Andy Dougherty F<E<lt>doughera@lafcol.lafayette.eduE<gt>>, Andreas
-KE<ouml>nig F<E<lt>A.Koenig@franz.ww.TU-Berlin.DEE<gt>>, Tim Bunce
-F<E<lt>Tim.Bunce@ig.co.ukE<gt>>. VMS support by Charles Bailey
-F<E<lt>bailey@HMIVAX.HUMGEN.UPENN.EDUE<gt>>. Contact the makemaker
-mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if you have any
-questions.
+Andy Dougherty <F<doughera@lafayette.edu>>, Andreas KE<ouml>nig
+<F<andreas.koenig@mind.de>>, Tim Bunce <F<timb@cpan.org>>. VMS
+support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
+by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
+
+Currently maintained by Michael G Schwern <F<schwern@pobox.com>>
+
+Send patches and ideas to <F<makemaker@perl.org>>.
+
+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.
-=head1 MODIFICATION HISTORY
+=head1 LICENSE
-For a more complete documentation see the file Changes in the
-MakeMaker distribution package.
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
-=head1 TODO
+See F<http://www.perl.com/perl/misc/Artistic.html>
-See the file Todo in the MakeMaker distribution package.
=cut