@EXPORT_FAIL fix for Exporter.pm
[p5sagit/p5-mst-13.2.git] / lib / ExtUtils / MakeMaker.pm
CommitLineData
f1387719 1BEGIN {require 5.002;} # MakeMaker 5.17 was the last MakeMaker that was compatible with perl5.001m
a0d0e21e 2
e05e23b1 3package ExtUtils::MakeMaker;
4
9607fc9c 5$Version = $VERSION = "5.4002";
f1387719 6$Version_OK = "5.17"; # Makefiles older than $Version_OK will die
8e07c86e 7 # (Will be checked from MakeMaker version 4.13 onwards)
ff0cee69 8($Revision = substr(q$Revision: 1.211 $, 10)) =~ s/\s+$//;
e05e23b1 9
10
005c1a0e 11
8e07c86e 12require Exporter;
3b03c0f3 13use Config;
14use Carp ();
15#use FileHandle ();
e05e23b1 16
17use vars qw(
f1387719 18
19 @ISA @EXPORT @EXPORT_OK $AUTOLOAD
20 $ISA_TTY $Is_Mac $Is_OS2 $Is_VMS $Revision $Setup_done
21 $VERSION $Verbose $Version_OK %Config %Keep_after_flush
22 %MM_Sections %Prepend_dot_dot %Recognized_Att_Keys
23 @Get_from_Config @MM_Sections @Overridable @Parent
24
e05e23b1 25 );
f1387719 26# use strict;
005c1a0e 27
760ac839 28# &DynaLoader::mod2fname should be available to miniperl, thus
29# should be a pseudo-builtin (cmp. os2.c).
30#eval {require DynaLoader;};
005c1a0e 31
e05e23b1 32#
33# Set up the inheritance before we pull in the MM_* packages, because they
34# import variables and functions from here
35#
36@ISA = qw(Exporter);
37@EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
3b03c0f3 38@EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists
f1387719 39 $Version);
e05e23b1 40 # $Version in mixed case will go away!
005c1a0e 41
e05e23b1 42#
43# Dummy package MM inherits actual methods from OS-specific
44# default packages. We use this intermediate package so
45# MY::XYZ->func() can call MM->func() and get the proper
46# default routine without having to know under what OS
47# it's running.
48#
49@MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist ExtUtils::MakeMaker];
42793c05 50
e05e23b1 51#
52# Setup dummy package:
53# MY exists for overriding methods to be defined within
54#
55{
56 package MY;
f1387719 57 @MY::ISA = qw(MM);
58### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
e05e23b1 59 package MM;
e05e23b1 60 sub DESTROY {}
61}
42793c05 62
3b03c0f3 63# "predeclare the package: we only load it via AUTOLOAD
64# but we have already mentioned it in @ISA
65package ExtUtils::Liblist;
66
67package ExtUtils::MakeMaker;
e05e23b1 68#
a5f75d66 69# Now we can can pull in the friends
e05e23b1 70#
3b03c0f3 71$Is_VMS = $^O eq 'VMS';
bab2b58e 72$Is_OS2 = $^O eq 'os2';
f1387719 73$Is_Mac = $^O eq 'MacOS';
a5f75d66 74
e05e23b1 75require ExtUtils::MM_Unix;
3b03c0f3 76
a5f75d66 77if ($Is_VMS) {
0d8023a2 78 require ExtUtils::MM_VMS;
f1387719 79 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
0d8023a2 80}
a5f75d66 81if ($Is_OS2) {
e05e23b1 82 require ExtUtils::MM_OS2;
83}
f1387719 84if ($Is_Mac) {
85 require ExtUtils::MM_Mac;
86}
3b03c0f3 87
88# The SelfLoader would bring a lot of overhead for MakeMaker, because
89# we know for sure we will use most of the autoloaded functions once
90# we have to use one of them. So we write our own loader
91
92sub AUTOLOAD {
93 my $code;
94 if (defined fileno(DATA)) {
f1387719 95 my $fh = select DATA;
96 my $o = $/; # For future reads from the file.
97 $/ = "\n__END__\n";
98 $code = <DATA>;
99 $/ = $o;
100 select $fh;
3b03c0f3 101 close DATA;
102 eval $code;
103 if ($@) {
104 $@ =~ s/ at .*\n//;
105 Carp::croak $@;
106 }
107 } else {
108 warn "AUTOLOAD called unexpectedly for $AUTOLOAD";
109 }
110 defined(&$AUTOLOAD) or die "Myloader inconsistency error";
111 goto &$AUTOLOAD;
112}
864a5fa8 113
e05e23b1 114# The only subroutine we do not SelfLoad is Version_Check because it's
115# called so often. Loading this minimum still requires 1.2 secs on my
116# Indy :-(
e05e23b1 117
118sub Version_check {
119 my($checkversion) = @_;
120 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
121Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
122changes in the meantime.
123Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
124 if $checkversion < $Version_OK;
125 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
126 $checkversion, "Current Version is", $VERSION
127 unless $checkversion == $VERSION;
8e07c86e 128}
e05e23b1 129
f1387719 130sub warnhandler {
131 $_[0] =~ /^Use of uninitialized value/ && return;
132 $_[0] =~ /used only once/ && return;
133 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
134 warn @_;
135}
136
3b03c0f3 137sub ExtUtils::MakeMaker::eval_in_subdirs ;
138sub ExtUtils::MakeMaker::eval_in_x ;
139sub ExtUtils::MakeMaker::full_setup ;
140sub ExtUtils::MakeMaker::writeMakefile ;
141sub ExtUtils::MakeMaker::new ;
142sub ExtUtils::MakeMaker::check_manifest ;
143sub ExtUtils::MakeMaker::parse_args ;
144sub ExtUtils::MakeMaker::check_hints ;
145sub ExtUtils::MakeMaker::mv_all_methods ;
146sub ExtUtils::MakeMaker::skipcheck ;
147sub ExtUtils::MakeMaker::flush ;
148sub ExtUtils::MakeMaker::mkbootstrap ;
149sub ExtUtils::MakeMaker::mksymlists ;
150sub ExtUtils::MakeMaker::neatvalue ;
151sub ExtUtils::MakeMaker::selfdocument ;
152sub ExtUtils::MakeMaker::WriteMakefile ;
153sub ExtUtils::MakeMaker::prompt ;
f1387719 154
1551;
ccd13d1e 156
157__DATA__
158
3b03c0f3 159package ExtUtils::MakeMaker;
160
161sub WriteMakefile {
162 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
f1387719 163 local $SIG{__WARN__} = \&warnhandler;
164
3b03c0f3 165 unless ($Setup_done++){
166 full_setup();
167 undef &ExtUtils::MakeMaker::full_setup; #safe memory
168 }
169 my %att = @_;
170 MM->new(\%att)->flush;
171}
172
f1387719 173sub prompt ($;$) {
3b03c0f3 174 my($mess,$def)=@_;
175 $ISA_TTY = -t STDIN && -t STDOUT ;
176 Carp::confess("prompt function called without an argument") unless defined $mess;
f1387719 177 my $dispdef = defined $def ? "[$def] " : " ";
178 $def = defined $def ? $def : "";
3b03c0f3 179 my $ans;
180 if ($ISA_TTY) {
181 local $|=1;
182 print "$mess $dispdef";
f1387719 183 chomp($ans = <STDIN>);
3b03c0f3 184 }
f1387719 185 return $ans || $def;
3b03c0f3 186}
187
e05e23b1 188sub eval_in_subdirs {
189 my($self) = @_;
190 my($dir);
3b03c0f3 191 use Cwd 'cwd';
e05e23b1 192 my $pwd = cwd();
193
e05e23b1 194 foreach $dir (@{$self->{DIR}}){
e05e23b1 195 my($abs) = $self->catdir($pwd,$dir);
196 $self->eval_in_x($abs);
197 }
e05e23b1 198 chdir $pwd;
864a5fa8 199}
42793c05 200
e05e23b1 201sub eval_in_x {
202 my($self,$dir) = @_;
203 package main;
3b03c0f3 204 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
205# use FileHandle ();
206# my $fh = new FileHandle;
207# $fh->open("Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
208 local *FH;
209 open(FH,"Makefile.PL") or Carp::carp("Couldn't open Makefile.PL in $dir");
210# my $eval = join "", <$fh>;
211 my $eval = join "", <FH>;
212# $fh->close;
213 close FH;
e05e23b1 214 eval $eval;
f1387719 215 if ($@) {
216# if ($@ =~ /prerequisites/) {
217# die "MakeMaker WARNING: $@";
218# } else {
219# warn "WARNING from evaluation of $dir/Makefile.PL: $@";
220# }
221 warn "WARNING from evaluation of $dir/Makefile.PL: $@";
222 }
e05e23b1 223}
224
e05e23b1 225sub full_setup {
226 $Verbose ||= 0;
227 $^W=1;
3b03c0f3 228
f1387719 229 # package name for the classes into which the first object will be blessed
3b03c0f3 230 $PACKNAME = "PACK000";
231
232 @Attrib_help = qw/
233
743a64fe 234 C CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
235 EXE_FILES EXCLUDE_EXT INCLUDE_EXT NO_VC FIRST_MAKEFILE FULLPERL H
236 INC INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
f1387719 237 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
238 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
bab2b58e 239 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIBPERL_A LIB LIBS
f1387719 240 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
241 NAME NEEDS_LINKING NOECHO NORECURS OBJECT OPTIMIZE PERL PERLMAINCC
242 PERL_ARCHLIB PERL_LIB PERL_SRC PL_FILES PM PMLIBDIRS PREFIX
243 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
244 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
245 tool_autosplit
3b03c0f3 246
9607fc9c 247 IMPORTS
385588b3 248
9607fc9c 249 installpm
3b03c0f3 250 /;
251
9607fc9c 252 # IMPORTS is used under OS/2
253
f1387719 254 # ^^^ installpm is deprecated, will go about Summer 96
255
256 # @Overridable is close to @MM_Sections but not identical. The
257 # order is important. Many subroutines declare macros. These
258 # depend on each other. Let's try to collect the macros up front,
259 # then pasthru, then the rules.
260
261 # MM_Sections are the sections we have to call explicitly
262 # in Overridable we have subroutines that are used indirectly
3b03c0f3 263
e05e23b1 264
265 @MM_Sections =
266 qw(
3b03c0f3 267
f1387719 268 post_initialize const_config constants tool_autosplit tool_xsubpp
269 tools_other dist macro depend cflags const_loadlibs const_cccmd
270 post_constants
271
272 pasthru
273
274 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
275 dynamic_lib static static_lib manifypods processPL installbin subdirs
276 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
277 install force perldepend makefile staticmake test
3b03c0f3 278
e05e23b1 279 ); # loses section ordering
280
3b03c0f3 281 @Overridable = @MM_Sections;
f1387719 282 push @Overridable, qw[
283
284 dir_target libscan makeaperl needs_linking subdir_x test_via_harness
285 test_via_script
286
3b03c0f3 287 ];
288
f1387719 289 push @MM_Sections, qw[
3b03c0f3 290
f1387719 291 pm_to_blib selfdocument
292
293 ];
294
295 # Postamble needs to be the last that was always the case
296 push @MM_Sections, "postamble";
297 push @Overridable, "postamble";
e05e23b1 298
299 # All sections are valid keys.
3b03c0f3 300 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
e05e23b1 301
302 # we will use all these variables in the Makefile
303 @Get_from_Config =
304 qw(
bbce6d69 305 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
451b636e 306 lib_ext obj_ext ranlib sitelibexp sitearchexp so
e05e23b1 307 );
308
309 my $item;
3b03c0f3 310 foreach $item (@Attrib_help){
311 $Recognized_Att_Keys{$item} = 1;
e05e23b1 312 }
313 foreach $item (@Get_from_Config) {
314 $Recognized_Att_Keys{uc $item} = $Config{$item};
315 print "Attribute '\U$item\E' => '$Config{$item}'\n"
316 if ($Verbose >= 2);
317 }
318
319 #
3b03c0f3 320 # When we eval a Makefile.PL in a subdirectory, that one will ask
321 # us (the parent) for the values and will prepend "..", so that
322 # all files to be installed end up below OUR ./blib
e05e23b1 323 #
324 %Prepend_dot_dot =
325 qw(
f1387719 326
327 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT
328 1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1
329 PERL 1 FULLPERL 1
330
e05e23b1 331 );
332
3b03c0f3 333 my @keep = qw/
334 NEEDS_LINKING HAS_LINK_CODE
335 /;
336 @Keep_after_flush{@keep} = (1) x @keep;
e05e23b1 337}
42793c05 338
8e07c86e 339sub writeMakefile {
340 die <<END;
232e078e 341
8e07c86e 342The extension you are trying to build apparently is rather old and
343most probably outdated. We detect that from the fact, that a
344subroutine "writeMakefile" is called, and this subroutine is not
345supported anymore since about October 1994.
40000a8c 346
4633a7c4 347Please contact the author or look into CPAN (details about CPAN can be
348found in the FAQ and at http:/www.perl.com) for a more recent version
349of the extension. If you're really desperate, you can try to change
350the subroutine name from writeMakefile to WriteMakefile and rerun
351'perl Makefile.PL', but you're most probably left alone, when you do
352so.
42793c05 353
8e07c86e 354The MakeMaker team
1aef975c 355
42793c05 356END
8e07c86e 357}
42793c05 358
3b03c0f3 359sub ExtUtils::MakeMaker::new {
8e07c86e 360 my($class,$self) = @_;
361 my($key);
42793c05 362
e05e23b1 363 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
8e07c86e 364 if (-f "MANIFEST" && ! -f "Makefile"){
365 check_manifest();
1aef975c 366 }
42793c05 367
8e07c86e 368 $self = {} unless (defined $self);
005c1a0e 369
864a5fa8 370 check_hints($self);
4633a7c4 371
8e07c86e 372 my(%initial_att) = %$self; # record initial attributes
005c1a0e 373
f1387719 374 my($prereq);
375 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
376 my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
377 eval $eval;
378 if ($@){
379 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
380 } else {
381 delete $self->{PREREQ_PM}{$prereq};
382 }
383 }
384# if (@unsatisfied){
385# unless (defined $ExtUtils::MakeMaker::useCPAN) {
386# print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
387# Please install these modules first and rerun 'perl Makefile.PL'.\n};
388# if ($ExtUtils::MakeMaker::hasCPAN) {
389# $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
390# } else {
391# print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
392# $ExtUtils::MakeMaker::useCPAN=0;
393# }
394# }
395# if ($ExtUtils::MakeMaker::useCPAN) {
396# require CPAN;
397# CPAN->import(@unsatisfied);
398# } else {
399# die qq{prerequisites not found (@unsatisfied)};
400# }
401# warn qq{WARNING: prerequisites not found (@unsatisfied)};
402# }
403
8e07c86e 404 if (defined $self->{CONFIGURE}) {
405 if (ref $self->{CONFIGURE} eq 'CODE') {
406 $self = { %$self, %{&{$self->{CONFIGURE}}}};
005c1a0e 407 } else {
3b03c0f3 408 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
005c1a0e 409 }
410 }
a0d0e21e 411
8e07c86e 412 # This is for old Makefiles written pre 5.00, will go away
413 if ( Carp::longmess("") =~ /runsubdirpl/s ){
3b03c0f3 414 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
8e07c86e 415 }
5d94fbed 416
ccd13d1e 417 my $newclass = ++$PACKNAME;
8e07c86e 418 {
419# no strict;
ccd13d1e 420 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
421 mv_all_methods("MY",$newclass);
422 bless $self, $newclass;
e05e23b1 423 push @Parent, $self;
ccd13d1e 424 @{"$newclass\:\:ISA"} = 'MM';
8e07c86e 425 }
5d94fbed 426
e05e23b1 427 if (defined $Parent[-2]){
428 $self->{PARENT} = $Parent[-2];
8e07c86e 429 my $key;
e05e23b1 430 for $key (keys %Prepend_dot_dot) {
4633a7c4 431 next unless defined $self->{PARENT}{$key};
8e07c86e 432 $self->{$key} = $self->{PARENT}{$key};
bbce6d69 433 # PERL and FULLPERL may be command verbs instead of full
434 # file specifications under VMS. If so, don't turn them
435 # into a filespec.
8e07c86e 436 $self->{$key} = $self->catdir("..",$self->{$key})
bbce6d69 437 unless $self->file_name_is_absolute($self->{$key})
f86702cc 438 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
8e07c86e 439 }
ccd13d1e 440 $self->{PARENT}->{CHILDREN}->{$newclass} = $self if $self->{PARENT};
8e07c86e 441 } else {
442 parse_args($self,@ARGV);
443 }
a0d0e21e 444
8e07c86e 445 $self->{NAME} ||= $self->guess_name;
a0d0e21e 446
8e07c86e 447 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
a0d0e21e 448
8e07c86e 449 $self->init_main();
450
0d8023a2 451 if (! $self->{PERL_SRC} ) {
452 my($pthinks) = $INC{'Config.pm'};
3b03c0f3 453 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
e05e23b1 454 if ($pthinks ne $self->catfile($Config{archlibexp},'Config.pm')){
0d8023a2 455 $pthinks =~ s!/Config\.pm$!!;
456 $pthinks =~ s!.*/!!;
457 print STDOUT <<END;
005c1a0e 458Your perl and your Config.pm seem to have different ideas about the architecture
459they are running on.
8e07c86e 460Perl thinks: [$pthinks]
e05e23b1 461Config says: [$Config{archname}]
005c1a0e 462This may or may not cause problems. Please check your installation of perl if you
463have problems building this extension.
464END
0d8023a2 465 }
005c1a0e 466 }
467
8e07c86e 468 $self->init_dirscan();
469 $self->init_others();
75f92628 470
8e07c86e 471 push @{$self->{RESULT}}, <<END;
472# This Makefile is for the $self->{NAME} extension to perl.
473#
e05e23b1 474# It was generated automatically by MakeMaker version
475# $VERSION (Revision: $Revision) from the contents of
476# Makefile.PL. Don't edit this file, edit Makefile.PL instead.
8e07c86e 477#
478# ANY CHANGES MADE HERE WILL BE LOST!
479#
480# MakeMaker Parameters:
481END
a0d0e21e 482
42793c05 483 foreach $key (sort keys %initial_att){
484 my($v) = neatvalue($initial_att{$key});
8e07c86e 485 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
42793c05 486 $v =~ tr/\n/ /s;
8e07c86e 487 push @{$self->{RESULT}}, "# $key => $v";
42793c05 488 }
a0d0e21e 489
8e07c86e 490 # turn the SKIP array into a SKIPHASH hash
491 my (%skip,$skip);
492 for $skip (@{$self->{SKIP} || []}) {
493 $self->{SKIPHASH}{$skip} = 1;
494 }
3b03c0f3 495 delete $self->{SKIP}; # free memory
496
497 if ($self->{PARENT}) {
498 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
499 $self->{SKIPHASH}{$_} = 1;
500 }
501 }
42793c05 502
8e07c86e 503 # We run all the subdirectories now. They don't have much to query
504 # from the parent, but the parent has to query them: if they need linking!
8e07c86e 505 unless ($self->{NORECURS}) {
e05e23b1 506 $self->eval_in_subdirs if @{$self->{DIR}};
42793c05 507 }
a0d0e21e 508
8e07c86e 509 my $section;
e05e23b1 510 foreach $section ( @MM_Sections ){
511 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
8e07c86e 512 my($skipit) = $self->skipcheck($section);
513 if ($skipit){
514 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
4e68a208 515 } else {
8e07c86e 516 my(%a) = %{$self->{$section} || {}};
517 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
e05e23b1 518 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
8e07c86e 519 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
e05e23b1 520 }
232e078e 521 }
8e07c86e 522
e05e23b1 523 push @{$self->{RESULT}}, "\n# End.";
524 pop @Parent;
8e07c86e 525
e05e23b1 526 $self;
232e078e 527}
528
e05e23b1 529sub check_manifest {
530 print STDOUT "Checking if your kit is complete...\n";
3b03c0f3 531 require ExtUtils::Manifest;
e05e23b1 532 $ExtUtils::Manifest::Quiet=$ExtUtils::Manifest::Quiet=1; #avoid warning
533 my(@missed)=ExtUtils::Manifest::manicheck();
534 if (@missed){
535 print STDOUT "Warning: the following files are missing in your kit:\n";
536 print "\t", join "\n\t", @missed;
537 print STDOUT "\n";
538 print STDOUT "Please inform the author.\n";
8e07c86e 539 } else {
e05e23b1 540 print STDOUT "Looks good\n";
8e07c86e 541 }
8e07c86e 542}
543
e05e23b1 544sub parse_args{
545 my($self, @args) = @_;
546 foreach (@args){
547 unless (m/(.*?)=(.*)/){
548 help(),exit 1 if m/^help$/;
549 ++$Verbose if m/^verb/;
550 next;
551 }
552 my($name, $value) = ($1, $2);
553 if ($value =~ m/^~(\w+)?/){ # tilde with optional username
554 $value =~ s [^~(\w*)]
555 [$1 ?
556 ((getpwnam($1))[7] || "~$1") :
557 (getpwuid($>))[7]
558 ]ex;
559 }
a5f75d66 560 $self->{uc($name)} = $value;
8e07c86e 561 }
8e07c86e 562
e05e23b1 563 # catch old-style 'potential_libs' and inform user how to 'upgrade'
564 if (defined $self->{potential_libs}){
565 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
566 if ($self->{potential_libs}){
567 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
568 } else {
569 print STDOUT "$msg deleted.\n";
570 }
571 $self->{LIBS} = [$self->{potential_libs}];
572 delete $self->{potential_libs};
8e07c86e 573 }
e05e23b1 574 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
575 if (defined $self->{ARMAYBE}){
576 my($armaybe) = $self->{ARMAYBE};
577 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
578 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
579 my(%dl) = %{$self->{dynamic_lib} || {}};
580 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
581 delete $self->{ARMAYBE};
8e07c86e 582 }
e05e23b1 583 if (defined $self->{LDTARGET}){
584 print STDOUT "LDTARGET should be changed to LDFROM\n";
585 $self->{LDFROM} = $self->{LDTARGET};
586 delete $self->{LDTARGET};
8e07c86e 587 }
e05e23b1 588 # Turn a DIR argument on the command line into an array
589 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
590 # So they can choose from the command line, which extensions they want
591 # the grep enables them to have some colons too much in case they
592 # have to build a list with the shell
593 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
8e07c86e 594 }
f1387719 595 # Turn a INCLUDE_EXT argument on the command line into an array
596 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
597 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
598 }
599 # Turn a EXCLUDE_EXT argument on the command line into an array
600 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
601 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
602 }
e05e23b1 603 my $mmkey;
604 foreach $mmkey (sort keys %$self){
605 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
606 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
607 unless exists $Recognized_Att_Keys{$mmkey};
608 }
f1387719 609 $| = 1 if $Verbose;
e05e23b1 610}
8e07c86e 611
e05e23b1 612sub check_hints {
613 my($self) = @_;
614 # We allow extension-specific hints files.
864a5fa8 615
e05e23b1 616 return unless -d "hints";
8e07c86e 617
e05e23b1 618 # First we look for the best hintsfile we have
619 my(@goodhints);
f1387719 620 my($hint)="${^O}_$Config{osvers}";
e05e23b1 621 $hint =~ s/\./_/g;
622 $hint =~ s/_$//;
623 return unless $hint;
fed7345c 624
e05e23b1 625 # Also try without trailing minor version numbers.
626 while (1) {
627 last if -f "hints/$hint.pl"; # found
628 } continue {
629 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
630 }
631 return unless -f "hints/$hint.pl"; # really there
fed7345c 632
e05e23b1 633 # execute the hintsfile:
3b03c0f3 634# use FileHandle ();
635# my $fh = new FileHandle;
636# $fh->open("hints/$hint.pl");
637 local *FH;
638 open(FH,"hints/$hint.pl");
639# @goodhints = <$fh>;
640 @goodhints = <FH>;
641# $fh->close;
642 close FH;
e05e23b1 643 print STDOUT "Processing hints file hints/$hint.pl\n";
644 eval join('',@goodhints);
645 print STDOUT $@ if $@;
646}
8e07c86e 647
e05e23b1 648sub mv_all_methods {
649 my($from,$to) = @_;
650 my($method);
651 my($symtab) = \%{"${from}::"};
652# no strict;
fed7345c 653
e05e23b1 654 # Here you see the *current* list of methods that are overridable
655 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
656 # still trying to reduce the list to some reasonable minimum --
657 # because I want to make it easier for the user. A.K.
40000a8c 658
3b03c0f3 659 foreach $method (@Overridable) {
fed7345c 660
e05e23b1 661 # We cannot say "next" here. Nick might call MY->makeaperl
662 # which isn't defined right now
fed7345c 663
3b03c0f3 664 # Above statement was written at 4.23 time when Tk-b8 was
665 # around. As Tk-b9 only builds with 5.002something and MM 5 is
666 # standard, we try to enable the next line again. It was
667 # commented out until MM 5.23
668
669 next unless defined &{"${from}::$method"};
fed7345c 670
e05e23b1 671 *{"${to}::$method"} = \&{"${from}::$method"};
8e07c86e 672
e05e23b1 673 # delete would do, if we were sure, nobody ever called
674 # MY->makeaperl directly
3b03c0f3 675
e05e23b1 676 # delete $symtab->{$method};
3b03c0f3 677
e05e23b1 678 # If we delete a method, then it will be undefined and cannot
679 # be called. But as long as we have Makefile.PLs that rely on
680 # %MY:: being intact, we have to fill the hole with an
681 # inheriting method:
fed7345c 682
f1387719 683 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
5d94fbed 684 }
685
e05e23b1 686 # We have to clean out %INC also, because the current directory is
687 # changed frequently and Graham Barr prefers to get his version
688 # out of a History.pl file which is "required" so woudn't get
689 # loaded again in another extension requiring a History.pl
a0d0e21e 690
f1387719 691 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
692 # to core dump in the middle of a require statement. The required
693 # file was Tk/MMutil.pm. The consequence is, we have to be
694 # extremely careful when we try to give perl a reason to reload a
695 # library with same name. The workaround prefers to drop nothing
696 # from %INC and teach the writers not to use such libraries.
697
698# my $inc;
699# foreach $inc (keys %INC) {
700# #warn "***$inc*** deleted";
701# delete $INC{$inc};
702# }
8e07c86e 703}
704
3b03c0f3 705sub skipcheck {
8e07c86e 706 my($self) = shift;
e05e23b1 707 my($section) = @_;
708 if ($section eq 'dynamic') {
709 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
710 "in skipped section 'dynamic_bs'\n"
711 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
712 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
713 "in skipped section 'dynamic_lib'\n"
714 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
8e07c86e 715 }
e05e23b1 716 if ($section eq 'dynamic_lib') {
717 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
718 "targets in skipped section 'dynamic_bs'\n"
719 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
720 }
721 if ($section eq 'static') {
722 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
723 "in skipped section 'static_lib'\n"
724 if $self->{SKIPHASH}{static_lib} && $Verbose;
8e07c86e 725 }
e05e23b1 726 return 'skipped' if $self->{SKIPHASH}{$section};
727 return '';
8e07c86e 728}
729
e05e23b1 730sub flush {
731 my $self = shift;
732 my($chunk);
3b03c0f3 733# use FileHandle ();
734# my $fh = new FileHandle;
735 local *FH;
e05e23b1 736 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
8e07c86e 737
e05e23b1 738 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
3b03c0f3 739# $fh->open(">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
740 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
8e07c86e 741
e05e23b1 742 for $chunk (@{$self->{RESULT}}) {
3b03c0f3 743# print $fh "$chunk\n";
744 print FH "$chunk\n";
8e07c86e 745 }
e05e23b1 746
3b03c0f3 747# $fh->close;
748 close FH;
e05e23b1 749 my($finalname) = $self->{MAKEFILE};
750 rename("MakeMaker.tmp", $finalname);
751 chmod 0644, $finalname unless $Is_VMS;
3b03c0f3 752
753 if ($self->{PARENT}) {
754 foreach (keys %$self) { # safe memory
755 delete $self->{$_} unless $Keep_after_flush{$_};
756 }
757 }
758
e05e23b1 759 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
40000a8c 760}
761
e05e23b1 762# The following mkbootstrap() is only for installations that are calling
763# the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
764# writes Makefiles, that use ExtUtils::Mkbootstrap directly.
765sub mkbootstrap {
766 die <<END;
767!!! Your Makefile has been built such a long time ago, !!!
768!!! that is unlikely to work with current MakeMaker. !!!
769!!! Please rebuild your Makefile !!!
770END
8e07c86e 771}
005c1a0e 772
e05e23b1 773# Ditto for mksymlists() as of MakeMaker 5.17
774sub mksymlists {
775 die <<END;
776!!! Your Makefile has been built such a long time ago, !!!
777!!! that is unlikely to work with current MakeMaker. !!!
778!!! Please rebuild your Makefile !!!
779END
4633a7c4 780}
781
e05e23b1 782sub neatvalue {
783 my($v) = @_;
784 return "undef" unless defined $v;
785 my($t) = ref $v;
786 return "q[$v]" unless $t;
787 if ($t eq 'ARRAY') {
788 my(@m, $elem, @neat);
789 push @m, "[";
790 foreach $elem (@$v) {
791 push @neat, "q[$elem]";
792 }
793 push @m, join ", ", @neat;
794 push @m, "]";
795 return join "", @m;
796 }
797 return "$v" unless $t eq 'HASH';
798 my(@m, $key, $val);
3b03c0f3 799 while (($key,$val) = each %$v){
800 last unless defined $key; # cautious programming in case (undef,undef) is true
801 push(@m,"$key=>".neatvalue($val)) ;
802 }
e05e23b1 803 return "{ ".join(', ',@m)." }";
4e68a208 804}
805
e05e23b1 806sub selfdocument {
807 my($self) = @_;
808 my(@m);
809 if ($Verbose){
810 push @m, "\n# Full list of MakeMaker attribute values:";
811 foreach $key (sort keys %$self){
812 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
813 my($v) = neatvalue($self->{$key});
814 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
815 $v =~ tr/\n/ /s;
816 push @m, "# $key => $v";
817 }
818 }
819 join "\n", @m;
820}
4e68a208 821
3b03c0f3 822package ExtUtils::MakeMaker;
8231;
824
825__END__
005c1a0e 826
827=head1 NAME
828
829ExtUtils::MakeMaker - create an extension Makefile
830
831=head1 SYNOPSIS
832
833C<use ExtUtils::MakeMaker;>
834
835C<WriteMakefile( ATTRIBUTE =E<gt> VALUE [, ...] );>
836
8e07c86e 837which is really
838
839C<MM-E<gt>new(\%att)-E<gt>flush;>
840
005c1a0e 841=head1 DESCRIPTION
842
843This utility is designed to write a Makefile for an extension module
844from a Makefile.PL. It is based on the Makefile.SH model provided by
845Andy Dougherty and the perl5-porters.
846
847It splits the task of generating the Makefile into several subroutines
848that can be individually overridden. Each subroutine returns the text
849it wishes to have written to the Makefile.
850
f1387719 851MakeMaker is object oriented. Each directory below the current
852directory that contains a Makefile.PL. Is treated as a separate
853object. This makes it possible to write an unlimited number of
854Makefiles with a single invocation of WriteMakefile().
8e07c86e 855
f1387719 856=head2 How To Write A Makefile.PL
8e07c86e 857
bab2b58e 858The short answer is: Don't.
859
860 Always begin with h2xs.
861 Always begin with h2xs!
862 ALWAYS BEGIN WITH H2XS!
863
864even if you're not building around a header file, and even if you
865don't have an XS component.
866
867Run h2xs(1) before you start thinking about writing a module. For so
868called pm-only modules that consist of C<*.pm> files only, h2xs has
869the C<-X> switch. This will generate dummy files of all kinds that are
870useful for the module developer.
8e07c86e 871
f1387719 872The medium answer is:
8e07c86e 873
f1387719 874 use ExtUtils::MakeMaker;
875 WriteMakefile( NAME => "Foo::Bar" );
8e07c86e 876
bab2b58e 877The long answer is the rest of the manpage :-)
005c1a0e 878
879=head2 Default Makefile Behaviour
880
f1387719 881The generated Makefile enables the user of the extension to invoke
005c1a0e 882
883 perl Makefile.PL # optionally "perl Makefile.PL verbose"
884 make
8e07c86e 885 make test # optionally set TEST_VERBOSE=1
886 make install # See below
005c1a0e 887
888The Makefile to be produced may be altered by adding arguments of the
e05e23b1 889form C<KEY=VALUE>. E.g.
005c1a0e 890
e05e23b1 891 perl Makefile.PL PREFIX=/tmp/myperl5
005c1a0e 892
893Other interesting targets in the generated Makefile are
894
895 make config # to check if the Makefile is up-to-date
8e07c86e 896 make clean # delete local temp files (Makefile gets renamed)
897 make realclean # delete derived files (including ./blib)
e05e23b1 898 make ci # check in all the files in the MANIFEST file
005c1a0e 899 make dist # see below the Distribution Support section
900
e05e23b1 901=head2 make test
902
bab2b58e 903MakeMaker checks for the existence of a file named F<test.pl> in the
e05e23b1 904current directory and if it exists it adds commands to the test target
905of the generated Makefile that will execute the script with the proper
906set of perl C<-I> options.
907
908MakeMaker also checks for any files matching glob("t/*.t"). It will
909add commands to the test target of the generated Makefile that execute
910all matching files via the L<Test::Harness> module with the C<-I>
911switches set correctly.
912
bab2b58e 913=head2 make testdb
914
915A useful variation of the above is the target C<testdb>. It runs the
916test under the Perl debugger (see L<perldebug>). If the file
917F<test.pl> exists in the current directory, it is used for the test.
918
919If you want to debug some other testfile, set C<TEST_FILE> variable
920thusly:
921
922 make testdb TEST_FILE=t/mytest.t
923
924By default the debugger is called using C<-d> option to perl. If you
925want to specify some other option, set C<TESTDB_SW> variable:
926
927 make testdb TESTDB_SW=-Dx
928
e05e23b1 929=head2 make install
005c1a0e 930
8e07c86e 931make alone puts all relevant files into directories that are named by
f1387719 932the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR, and
933INST_MAN3DIR. All these default to something below ./blib if you are
934I<not> building below the perl source directory. If you I<are>
8e07c86e 935building below the perl source, INST_LIB and INST_ARCHLIB default to
5b195008 936 ../../lib, and INST_SCRIPT is not defined.
005c1a0e 937
e05e23b1 938The I<install> target of the generated Makefile copies the files found
939below each of the INST_* directories to their INSTALL*
940counterparts. Which counterparts are chosen depends on the setting of
941INSTALLDIRS according to the following table:
005c1a0e 942
e05e23b1 943 INSTALLDIRS set to
944 perl site
945
e05e23b1 946 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
3b03c0f3 947 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
f1387719 948 INST_BIN INSTALLBIN
949 INST_SCRIPT INSTALLSCRIPT
e05e23b1 950 INST_MAN1DIR INSTALLMAN1DIR
951 INST_MAN3DIR INSTALLMAN3DIR
005c1a0e 952
8e07c86e 953The INSTALL... macros in turn default to their %Config
954($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
005c1a0e 955
3b03c0f3 956You can check the values of these variables on your system with
957
bab2b58e 958 perl '-V:install.*'
3b03c0f3 959
f1387719 960And to check the sequence in which the library directories are
961searched by perl, run
005c1a0e 962
f1387719 963 perl -le 'print join $/, @INC'
005c1a0e 964
005c1a0e 965
bab2b58e 966=head2 PREFIX and LIB attribute
967
968PREFIX and LIB can be used to set several INSTALL* attributes in one
969go. The quickest way to install a module in a non-standard place might
970be
971
972 perl Makefile.PL LIB=~/lib
005c1a0e 973
bab2b58e 974This will install the module's architecture-independent files into
975~/lib, the architecture-dependent files into ~/lib/$archname/auto.
976
977Another way to specify many INSTALL directories with a single
978parameter is PREFIX.
005c1a0e 979
8e07c86e 980 perl Makefile.PL PREFIX=~
005c1a0e 981
0d8023a2 982This will replace the string specified by $Config{prefix} in all
983$Config{install*} values.
005c1a0e 984
bab2b58e 985Note, that in both cases the tilde expansion is done by MakeMaker, not
986by perl by default, nor by make. Conflicts between parmeters LIB,
987PREFIX and the various INSTALL* arguments are resolved so that
988XXX
005c1a0e 989
005c1a0e 990If the user has superuser privileges, and is not working on AFS
991(Andrew File System) or relatives, then the defaults for
f1387719 992INSTALLPRIVLIB, INSTALLARCHLIB, INSTALLSCRIPT, etc. will be appropriate,
005c1a0e 993and this incantation will be the best:
994
995 perl Makefile.PL; make; make test
996 make install
997
8e07c86e 998make install per default writes some documentation of what has been
e05e23b1 999done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1000can be bypassed by calling make pure_install.
8e07c86e 1001
1002=head2 AFS users
1003
1004will have to specify the installation directories as these most
1005probably have changed since perl itself has been installed. They will
1006have to do this by calling
1007
e05e23b1 1008 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
f1387719 1009 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
8e07c86e 1010 make
1011
e05e23b1 1012Be careful to repeat this procedure every time you recompile an
1013extension, unless you are sure the AFS installation directories are
1014still valid.
005c1a0e 1015
8e07c86e 1016=head2 Static Linking of a new Perl Binary
005c1a0e 1017
1018An extension that is built with the above steps is ready to use on
1019systems supporting dynamic loading. On systems that do not support
1020dynamic loading, any newly created extension has to be linked together
1021with the available resources. MakeMaker supports the linking process
1022by creating appropriate targets in the Makefile whenever an extension
1023is built. You can invoke the corresponding section of the makefile with
1024
1025 make perl
1026
1027That produces a new perl binary in the current directory with all
e05e23b1 1028extensions linked in that can be found in INST_ARCHLIB , SITELIBEXP,
1029and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1030UNIX, this is called Makefile.aperl (may be system dependent). If you
1031want to force the creation of a new perl, it is recommended, that you
1032delete this Makefile.aperl, so the directories are searched-through
1033for linkable libraries again.
005c1a0e 1034
1035The binary can be installed into the directory where perl normally
1036resides on your machine with
1037
1038 make inst_perl
1039
1040To produce a perl binary with a different name than C<perl>, either say
1041
1042 perl Makefile.PL MAP_TARGET=myperl
1043 make myperl
1044 make inst_perl
1045
1046or say
1047
1048 perl Makefile.PL
1049 make myperl MAP_TARGET=myperl
1050 make inst_perl MAP_TARGET=myperl
1051
1052In any case you will be prompted with the correct invocation of the
1053C<inst_perl> target that installs the new binary into INSTALLBIN.
1054
8e07c86e 1055make inst_perl per default writes some documentation of what has been
1056done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1057can be bypassed by calling make pure_inst_perl.
005c1a0e 1058
e05e23b1 1059Warning: the inst_perl: target will most probably overwrite your
1060existing perl binary. Use with care!
005c1a0e 1061
8e07c86e 1062Sometimes you might want to build a statically linked perl although
1063your system supports dynamic loading. In this case you may explicitly
1064set the linktype with the invocation of the Makefile.PL or make:
1065
1066 perl Makefile.PL LINKTYPE=static # recommended
1067
1068or
1069
1070 make LINKTYPE=static # works on most systems
1071
005c1a0e 1072=head2 Determination of Perl Library and Installation Locations
1073
1074MakeMaker needs to know, or to guess, where certain things are
e05e23b1 1075located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1076during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1077existing modules from), and PERL_INC (header files and C<libperl*.*>).
005c1a0e 1078
1079Extensions may be built either using the contents of the perl source
e05e23b1 1080directory tree or from the installed perl library. The recommended way
1081is to build extensions after you have run 'make install' on perl
1082itself. You can do that in any directory on your hard disk that is not
1083below the perl source tree. The support for extensions below the ext
1084directory of the perl distribution is only good for the standard
1085extensions that come with perl.
005c1a0e 1086
1087If an extension is being built below the C<ext/> directory of the perl
e05e23b1 1088source then MakeMaker will set PERL_SRC automatically (e.g.,
1089C<../..>). If PERL_SRC is defined and the extension is recognized as
1090a standard extension, then other variables default to the following:
005c1a0e 1091
1092 PERL_INC = PERL_SRC
1093 PERL_LIB = PERL_SRC/lib
1094 PERL_ARCHLIB = PERL_SRC/lib
1095 INST_LIB = PERL_LIB
1096 INST_ARCHLIB = PERL_ARCHLIB
1097
1098If an extension is being built away from the perl source then MakeMaker
1099will leave PERL_SRC undefined and default to using the installed copy
1100of the perl library. The other variables default to the following:
1101
e05e23b1 1102 PERL_INC = $archlibexp/CORE
1103 PERL_LIB = $privlibexp
1104 PERL_ARCHLIB = $archlibexp
1105 INST_LIB = ./blib/lib
1106 INST_ARCHLIB = ./blib/arch
005c1a0e 1107
1108If perl has not yet been installed then PERL_SRC can be defined on the
1109command line as shown in the previous section.
1110
005c1a0e 1111
f1387719 1112=head2 Which architecture dependent directory?
005c1a0e 1113
f1387719 1114If you don't want to keep the defaults for the INSTALL* macros,
1115MakeMaker helps you to minimize the typing needed: the usual
1116relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1117by Configure at perl compilation time. MakeMaker supports the user who
1118sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1119then MakeMaker defaults the latter to be the same subdirectory of
1120INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1121otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1122for INSTALLSITELIB and INSTALLSITEARCH.
005c1a0e 1123
f1387719 1124MakeMaker gives you much more freedom than needed to configure
1125internal variables and get different results. It is worth to mention,
1126that make(1) also lets you configure most of the variables that are
1127used in the Makefile. But in the majority of situations this will not
1128be necessary, and should only be done, if the author of a package
1129recommends it (or you know what you're doing).
005c1a0e 1130
e05e23b1 1131=head2 Using Attributes and Parameters
005c1a0e 1132
1133The following attributes can be specified as arguments to WriteMakefile()
1134or as NAME=VALUE pairs on the command line:
1135
8e07c86e 1136=cut
005c1a0e 1137
864a5fa8 1138# The following "=item C" is used by the attrib_help routine
8e07c86e 1139# likewise the "=back" below. So be careful when changing it!
1140
1141=over 2
1142
864a5fa8 1143=item C
8e07c86e 1144
864a5fa8 1145Ref to array of *.c file names. Initialised from a directory scan
1146and the values portion of the XS attribute hash. This is not
1147currently used by MakeMaker but may be handy in Makefile.PLs.
8e07c86e 1148
864a5fa8 1149=item CONFIG
8e07c86e 1150
864a5fa8 1151Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1152config.sh. MakeMaker will add to CONFIG the following values anyway:
1153ar
1154cc
1155cccdlflags
1156ccdlflags
1157dlext
1158dlsrc
1159ld
1160lddlflags
1161ldflags
1162libc
1163lib_ext
1164obj_ext
1165ranlib
e05e23b1 1166sitelibexp
1167sitearchexp
864a5fa8 1168so
8e07c86e 1169
1170=item CONFIGURE
1171
e05e23b1 1172CODE reference. The subroutine should return a hash reference. The
1fef88e7 1173hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
8e07c86e 1174be determined by some evaluation method.
1175
864a5fa8 1176=item DEFINE
8e07c86e 1177
864a5fa8 1178Something like C<"-DHAVE_UNISTD_H">
8e07c86e 1179
864a5fa8 1180=item DIR
8e07c86e 1181
864a5fa8 1182Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1183] in ext/SDBM_File
8e07c86e 1184
864a5fa8 1185=item DISTNAME
8e07c86e 1186
e05e23b1 1187Your name for distributing the package (by tar file). This defaults to
864a5fa8 1188NAME above.
8e07c86e 1189
864a5fa8 1190=item DL_FUNCS
8e07c86e 1191
864a5fa8 1192Hashref of symbol names for routines to be made available as
1193universal symbols. Each key/value pair consists of the package name
1194and an array of routine names in that package. Used only under AIX
1195(export lists) and VMS (linker options) at present. The routine
1196names supplied will be expanded in the same way as XSUB names are
1197expanded by the XS() macro. Defaults to
8e07c86e 1198
864a5fa8 1199 {"$(NAME)" => ["boot_$(NAME)" ] }
8e07c86e 1200
864a5fa8 1201e.g.
8e07c86e 1202
864a5fa8 1203 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1204 "NetconfigPtr" => [ 'DESTROY'] }
8e07c86e 1205
864a5fa8 1206=item DL_VARS
8e07c86e 1207
864a5fa8 1208Array of symbol names for variables to be made available as
1209universal symbols. Used only under AIX (export lists) and VMS
1210(linker options) at present. Defaults to []. (e.g. [ qw(
1211Foo_version Foo_numstreams Foo_tree ) ])
8e07c86e 1212
f1387719 1213=item EXCLUDE_EXT
1214
1215Array of extension names to exclude when doing a static build. This
1216is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1217details. (e.g. [ qw( Socket POSIX ) ] )
1218
1219This attribute may be most useful when specified as a string on the
1220commandline: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1221
864a5fa8 1222=item EXE_FILES
8e07c86e 1223
864a5fa8 1224Ref to array of executable files. The files will be copied to the
f1387719 1225INST_SCRIPT directory. Make realclean will delete them from there
864a5fa8 1226again.
8e07c86e 1227
3b03c0f3 1228=item NO_VC
1229
1230In general any generated Makefile checks for the current version of
1231MakeMaker and the version the Makefile was built under. If NO_VC is
1232set, the version check is neglected. Do not write this into your
1233Makefile.PL, use it interactively instead.
1234
864a5fa8 1235=item FIRST_MAKEFILE
1236
1237The name of the Makefile to be produced. Defaults to the contents of
1238MAKEFILE, but can be overridden. This is used for the second Makefile
1239that will be produced for the MAP_TARGET.
1240
1241=item FULLPERL
8e07c86e 1242
864a5fa8 1243Perl binary able to run this extension.
1244
1245=item H
1246
1247Ref to array of *.h file names. Similar to C.
1248
1249=item INC
1250
1251Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1252
f1387719 1253=item INCLUDE_EXT
1254
1255Array of extension names to be included when doing a static build.
1256MakeMaker will normally build with all of the installed extensions when
1257doing a static build, and that is usually the desired behavior. If
1258INCLUDE_EXT is present then MakeMaker will build only with those extensions
1259which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1260
1261It is not necessary to mention DynaLoader or the current extension when
1262filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1263only DynaLoader and the current extension will be included in the build.
1264
1265This attribute may be most useful when specified as a string on the
1266commandline: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1267
864a5fa8 1268=item INSTALLARCHLIB
1269
e05e23b1 1270Used by 'make install', which copies files from INST_ARCHLIB to this
1271directory if INSTALLDIRS is set to perl.
864a5fa8 1272
1273=item INSTALLBIN
1274
f1387719 1275Directory to install binary files (e.g. tkperl) into.
e05e23b1 1276
1277=item INSTALLDIRS
1278
1279Determines which of the two sets of installation directories to
1280choose: installprivlib and installarchlib versus installsitelib and
1281installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1282second with INSTALLDIRS=site. Default is site.
8e07c86e 1283
1284=item INSTALLMAN1DIR
1285
864a5fa8 1286This directory gets the man pages at 'make install' time. Defaults to
1287$Config{installman1dir}.
1288
8e07c86e 1289=item INSTALLMAN3DIR
1290
864a5fa8 1291This directory gets the man pages at 'make install' time. Defaults to
1292$Config{installman3dir}.
8e07c86e 1293
864a5fa8 1294=item INSTALLPRIVLIB
8e07c86e 1295
e05e23b1 1296Used by 'make install', which copies files from INST_LIB to this
1297directory if INSTALLDIRS is set to perl.
1298
f1387719 1299=item INSTALLSCRIPT
1300
1301Used by 'make install' which copies files from INST_SCRIPT to this
1302directory.
1303
e05e23b1 1304=item INSTALLSITELIB
1305
1306Used by 'make install', which copies files from INST_LIB to this
1307directory if INSTALLDIRS is set to site (default).
1308
1309=item INSTALLSITEARCH
1310
1311Used by 'make install', which copies files from INST_ARCHLIB to this
1312directory if INSTALLDIRS is set to site (default).
8e07c86e 1313
864a5fa8 1314=item INST_ARCHLIB
8e07c86e 1315
864a5fa8 1316Same as INST_LIB for architecture dependent files.
8e07c86e 1317
f1387719 1318=item INST_BIN
1319
1320Directory to put real binary files during 'make'. These will be copied
1321to INSTALLBIN during 'make install'
1322
864a5fa8 1323=item INST_EXE
8e07c86e 1324
f1387719 1325Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1326need to use it.
8e07c86e 1327
864a5fa8 1328=item INST_LIB
8e07c86e 1329
864a5fa8 1330Directory where we put library files of this extension while building
1331it.
8e07c86e 1332
864a5fa8 1333=item INST_MAN1DIR
8e07c86e 1334
864a5fa8 1335Directory to hold the man pages at 'make' time
8e07c86e 1336
864a5fa8 1337=item INST_MAN3DIR
8e07c86e 1338
864a5fa8 1339Directory to hold the man pages at 'make' time
8e07c86e 1340
f1387719 1341=item INST_SCRIPT
1342
1343Directory, where executable files should be installed during
1344'make'. Defaults to "./blib/bin", just to have a dummy location during
1345testing. make install will copy the files in INST_SCRIPT to
1346INSTALLSCRIPT.
1347
864a5fa8 1348=item LDFROM
8e07c86e 1349
864a5fa8 1350defaults to "$(OBJECT)" and is used in the ld command to specify
1351what files to link/load from (also see dynamic_lib below for how to
1352specify ld flags)
8e07c86e 1353
864a5fa8 1354=item LIBPERL_A
8e07c86e 1355
864a5fa8 1356The filename of the perllibrary that will be used together with this
1357extension. Defaults to libperl.a.
8e07c86e 1358
bab2b58e 1359=item LIB
1360
1361LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1362setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1363
8e07c86e 1364=item LIBS
1365
1366An anonymous array of alternative library
1367specifications to be searched for (in order) until
864a5fa8 1368at least one library is found. E.g.
8e07c86e 1369
1370 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1371
1372Mind, that any element of the array
1373contains a complete set of arguments for the ld
1374command. So do not specify
1375
1376 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1377
1378See ODBM_File/Makefile.PL for an example, where an array is needed. If
1379you specify a scalar as in
1380
1381 'LIBS' => "-ltcl -ltk -lX11"
1382
1383MakeMaker will turn it into an array with one element.
1384
864a5fa8 1385=item LINKTYPE
8e07c86e 1386
e05e23b1 1387'static' or 'dynamic' (default unless usedl=undef in
1388config.sh). Should only be used to force static linking (also see
864a5fa8 1389linkext below).
8e07c86e 1390
864a5fa8 1391=item MAKEAPERL
8e07c86e 1392
864a5fa8 1393Boolean which tells MakeMaker, that it should include the rules to
1394make a perl. This is handled automatically as a switch by
1395MakeMaker. The user normally does not need it.
8e07c86e 1396
864a5fa8 1397=item MAKEFILE
8e07c86e 1398
864a5fa8 1399The name of the Makefile to be produced.
8e07c86e 1400
864a5fa8 1401=item MAN1PODS
8e07c86e 1402
864a5fa8 1403Hashref of pod-containing files. MakeMaker will default this to all
1404EXE_FILES files that include POD directives. The files listed
1405here will be converted to man pages and installed as was requested
1406at Configure time.
8e07c86e 1407
864a5fa8 1408=item MAN3PODS
8e07c86e 1409
864a5fa8 1410Hashref of .pm and .pod files. MakeMaker will default this to all
1411 .pod and any .pm files that include POD directives. The files listed
1412here will be converted to man pages and installed as was requested
1413at Configure time.
8e07c86e 1414
864a5fa8 1415=item MAP_TARGET
8e07c86e 1416
864a5fa8 1417If it is intended, that a new perl binary be produced, this variable
1418may hold a name for that binary. Defaults to perl
8e07c86e 1419
864a5fa8 1420=item MYEXTLIB
4633a7c4 1421
864a5fa8 1422If the extension links to a library that it builds set this to the
1423name of the library (see SDBM_File)
4633a7c4 1424
864a5fa8 1425=item NAME
8e07c86e 1426
864a5fa8 1427Perl module name for this extension (DBD::Oracle). This will default
1428to the directory name but should be explicitly defined in the
1429Makefile.PL.
8e07c86e 1430
864a5fa8 1431=item NEEDS_LINKING
8e07c86e 1432
864a5fa8 1433MakeMaker will figure out, if an extension contains linkable code
1434anywhere down the directory tree, and will set this variable
1435accordingly, but you can speed it up a very little bit, if you define
1436this boolean variable yourself.
8e07c86e 1437
e05e23b1 1438=item NOECHO
1439
f1387719 1440Defaults to C<@>. By setting it to an empty string you can generate a
e05e23b1 1441Makefile that echos all commands. Mainly used in debugging MakeMaker
1442itself.
1443
864a5fa8 1444=item NORECURS
8e07c86e 1445
e05e23b1 1446Boolean. Attribute to inhibit descending into subdirectories.
8e07c86e 1447
864a5fa8 1448=item OBJECT
8e07c86e 1449
864a5fa8 1450List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1451string containing all object files, e.g. "tkpBind.o
1452tkpButton.o tkpCanvas.o"
8e07c86e 1453
3b03c0f3 1454=item OPTIMIZE
1455
1456Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1457passed to subdirectory makes.
1458
864a5fa8 1459=item PERL
8e07c86e 1460
864a5fa8 1461Perl binary for tasks that can be done by miniperl
8e07c86e 1462
864a5fa8 1463=item PERLMAINCC
005c1a0e 1464
864a5fa8 1465The call to the program that is able to compile perlmain.c. Defaults
1466to $(CC).
005c1a0e 1467
864a5fa8 1468=item PERL_ARCHLIB
005c1a0e 1469
864a5fa8 1470Same as above for architecture dependent files
8e07c86e 1471
864a5fa8 1472=item PERL_LIB
8e07c86e 1473
864a5fa8 1474Directory containing the Perl library to use.
8e07c86e 1475
864a5fa8 1476=item PERL_SRC
8e07c86e 1477
864a5fa8 1478Directory containing the Perl source code (use of this should be
1479avoided, it may be undefined)
8e07c86e 1480
864a5fa8 1481=item PL_FILES
8e07c86e 1482
864a5fa8 1483Ref to hash of files to be processed as perl programs. MakeMaker
1484will default to any found *.PL file (except Makefile.PL) being keys
1485and the basename of the file being the value. E.g.
8e07c86e 1486
864a5fa8 1487 {'foobar.PL' => 'foobar'}
8e07c86e 1488
864a5fa8 1489The *.PL files are expected to produce output to the target files
1490themselves.
8e07c86e 1491
864a5fa8 1492=item PM
8e07c86e 1493
864a5fa8 1494Hashref of .pm files and *.pl files to be installed. e.g.
8e07c86e 1495
864a5fa8 1496 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
8e07c86e 1497
864a5fa8 1498By default this will include *.pm and *.pl. If a lib directory
1499exists and is not listed in DIR (above) then any *.pm and *.pl files
1500it contains will also be included by default. Defining PM in the
1501Makefile.PL will override PMLIBDIRS.
8e07c86e 1502
864a5fa8 1503=item PMLIBDIRS
8e07c86e 1504
864a5fa8 1505Ref to array of subdirectories containing library files. Defaults to
1506[ 'lib', $(BASEEXT) ]. The directories will be scanned and any files
1507they contain will be installed in the corresponding location in the
1508library. A libscan() method can be used to alter the behaviour.
1509Defining PM in the Makefile.PL will override PMLIBDIRS.
8e07c86e 1510
864a5fa8 1511=item PREFIX
8e07c86e 1512
864a5fa8 1513Can be used to set the three INSTALL* attributes in one go (except for
e05e23b1 1514probably INSTALLMAN1DIR, if it is not below PREFIX according to
1515%Config). They will have PREFIX as a common directory node and will
1516branch from that node into lib/, lib/ARCHNAME or whatever Configure
1517decided at the build time of your perl (unless you override one of
1518them, of course).
8e07c86e 1519
f1387719 1520=item PREREQ_PM
8e07c86e 1521
f1387719 1522Hashref: Names of modules that need to be available to run this
1523extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1524desired version is the value. If the required version number is 0, we
1525only check if any version is installed already.
8e07c86e 1526
864a5fa8 1527=item SKIP
8e07c86e 1528
864a5fa8 1529Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
f1387719 1530Makefile. Caution! Do not use the SKIP attribute for the neglectible
1531speedup. It may seriously damage the resulting Makefile. Only use it,
1532if you really need it.
8e07c86e 1533
864a5fa8 1534=item TYPEMAPS
8e07c86e 1535
864a5fa8 1536Ref to array of typemap file names. Use this when the typemaps are
1537in some directory other than the current directory or when they are
1538not named B<typemap>. The last typemap in the list takes
1539precedence. A typemap in the current directory has highest
1540precedence, even if it isn't listed in TYPEMAPS. The default system
1541typemap has lowest precedence.
8e07c86e 1542
864a5fa8 1543=item VERSION
8e07c86e 1544
864a5fa8 1545Your version number for distributing the package. This defaults to
15460.1.
8e07c86e 1547
0d8023a2 1548=item VERSION_FROM
1549
1550Instead of specifying the VERSION in the Makefile.PL you can let
1551MakeMaker parse a file to determine the version number. The parsing
1552routine requires that the file named by VERSION_FROM contains one
1553single line to compute the version number. The first line in the file
1554that contains the regular expression
1555
5b195008 1556 /\$(([\w\:\']*)\bVERSION)\b.*\=/
0d8023a2 1557
1558will be evaluated with eval() and the value of the named variable
1559B<after> the eval() will be assigned to the VERSION attribute of the
1560MakeMaker object. The following lines will be parsed o.k.:
1561
1562 $VERSION = '1.00';
ff0cee69 1563 ( $VERSION ) = '$Revision: 1.211 $ ' =~ /\$Revision:\s+([^\s]+)/;
0d8023a2 1564 $FOO::VERSION = '1.10';
1565
1566but these will fail:
1567
1568 my $VERSION = '1.01';
1569 local $VERSION = '1.02';
1570 local $FOO::VERSION = '1.30';
1571
1572The file named in VERSION_FROM is added as a dependency to Makefile to
1573guarantee, that the Makefile contains the correct VERSION macro after
1574a change of the file.
1575
864a5fa8 1576=item XS
8e07c86e 1577
864a5fa8 1578Hashref of .xs files. MakeMaker will default this. e.g.
8e07c86e 1579
864a5fa8 1580 {'name_of_file.xs' => 'name_of_file.c'}
8e07c86e 1581
864a5fa8 1582The .c files will automatically be included in the list of files
1583deleted by a make clean.
4633a7c4 1584
864a5fa8 1585=item XSOPT
8e07c86e 1586
864a5fa8 1587String of options to pass to xsubpp. This might include C<-C++> or
1588C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1589that purpose.
8e07c86e 1590
864a5fa8 1591=item XSPROTOARG
4633a7c4 1592
4e68a208 1593May be set to an empty string, which is identical to C<-prototypes>, or
864a5fa8 1594C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
4e68a208 1595defaults to the empty string.
1596
0d8023a2 1597=item XS_VERSION
1598
1599Your version number for the .xs file of this package. This defaults
1600to the value of the VERSION attribute.
1601
8e07c86e 1602=back
1603
1604=head2 Additional lowercase attributes
1605
1606can be used to pass parameters to the methods which implement that
f1387719 1607part of the Makefile.
8e07c86e 1608
1609=over 2
1610
864a5fa8 1611=item clean
8e07c86e 1612
864a5fa8 1613 {FILES => "*.xyz foo"}
1614
c07a80fd 1615=item depend
1616
1617 {ANY_TARGET => ANY_DEPENDECY, ...}
1618
864a5fa8 1619=item dist
1620
1621 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => 'gz',
3b03c0f3 1622 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
f1387719 1623 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
864a5fa8 1624
1625If you specify COMPRESS, then SUFFIX should also be altered, as it is
1626needed to tell make the target file of the compression. Setting
1627DIST_CP to ln can be useful, if you need to preserve the timestamps on
1628your files. DIST_CP can take the values 'cp', which copies the file,
1629'ln', which links the file, and 'best' which copies symbolic links and
1630links the rest. Default is 'best'.
1631
1632=item dynamic_lib
1633
0d8023a2 1634 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
8e07c86e 1635
1636=item installpm
1637
3b03c0f3 1638Deprecated as of MakeMaker 5.23. See L<ExtUtils::MM_Unix/pm_to_blib>.
8e07c86e 1639
1640=item linkext
1641
1642 {LINKTYPE => 'static', 'dynamic' or ''}
1643
864a5fa8 1644NB: Extensions that have nothing but *.pm files had to say
8e07c86e 1645
1646 {LINKTYPE => ''}
1647
864a5fa8 1648with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1649can be deleted safely. MakeMaker recognizes, when there's nothing to
1650be linked.
8e07c86e 1651
864a5fa8 1652=item macro
8e07c86e 1653
864a5fa8 1654 {ANY_MACRO => ANY_VALUE, ...}
8e07c86e 1655
1656=item realclean
1657
1658 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1659
8e07c86e 1660=item tool_autosplit
1661
1662 {MAXLEN =E<gt> 8}
005c1a0e 1663
1664=back
1665
8e07c86e 1666=cut
1667
1668# bug in pod2html, so leave the =back
1669
1670# Don't delete this cut, MM depends on it!
1671
005c1a0e 1672=head2 Overriding MakeMaker Methods
1673
1674If you cannot achieve the desired Makefile behaviour by specifying
1675attributes you may define private subroutines in the Makefile.PL.
1676Each subroutines returns the text it wishes to have written to
1677the Makefile. To override a section of the Makefile you can
1678either say:
1679
1680 sub MY::c_o { "new literal text" }
1681
1682or you can edit the default by saying something like:
1683
8e07c86e 1684 sub MY::c_o {
f1387719 1685 my($inherited) = shift->SUPER::c_o(@_);
1686 $inherited =~ s/old text/new text/;
1687 $inherited;
8e07c86e 1688 }
1689
f1387719 1690If you running experiments with embedding perl as a library into other
1691applications, you might find MakeMaker not sufficient. You'd better
1692have a look at ExtUtils::embed which is a collection of utilities for
1693embedding.
005c1a0e 1694
1695If you still need a different solution, try to develop another
1696subroutine, that fits your needs and submit the diffs to
8e07c86e 1697F<perl5-porters@nicoh.com> or F<comp.lang.perl.misc> as appropriate.
005c1a0e 1698
3b03c0f3 1699For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1700
1701Here is a simple example of how to add a new target to the generated
1702Makefile:
1703
1704 sub MY::postamble {
1705 '
1706 $(MYEXTLIB): sdbm/Makefile
1707 cd sdbm && $(MAKE) all
1708 ';
1709 }
1710
1711
f1387719 1712=head2 Hintsfile support
1713
1714MakeMaker.pm uses the architecture specific information from
1715Config.pm. In addition it evaluates architecture specific hints files
1716in a C<hints/> directory. The hints files are expected to be named
1717like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1718name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1719MakeMaker within the WriteMakefile() subroutine, and can be used to
1720execute commands as well as to include special variables. The rules
1721which hintsfile is chosen are the same as in Configure.
1722
1723The hintsfile is eval()ed immediately after the arguments given to
1724WriteMakefile are stuffed into a hash reference $self but before this
1725reference becomes blessed. So if you want to do the equivalent to
1726override or create an attribute you would say something like
1727
1728 $self->{LIBS} = ['-ldbm -lucb -lc'];
1729
005c1a0e 1730=head2 Distribution Support
1731
1732For authors of extensions MakeMaker provides several Makefile
1733targets. Most of the support comes from the ExtUtils::Manifest module,
1734where additional documentation can be found.
1735
1736=over 4
1737
1738=item make distcheck
8e07c86e 1739
005c1a0e 1740reports which files are below the build directory but not in the
1741MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1742details)
1743
4633a7c4 1744=item make skipcheck
1745
1746reports which files are skipped due to the entries in the
1747C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1748details)
1749
005c1a0e 1750=item make distclean
8e07c86e 1751
005c1a0e 1752does a realclean first and then the distcheck. Note that this is not
1753needed to build a new distribution as long as you are sure, that the
1754MANIFEST file is ok.
1755
1756=item make manifest
8e07c86e 1757
005c1a0e 1758rewrites the MANIFEST file, adding all remaining files found (See
1759ExtUtils::Manifest::mkmanifest() for details)
1760
1761=item make distdir
8e07c86e 1762
005c1a0e 1763Copies all the files that are in the MANIFEST file to a newly created
1764directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1765exists, it will be removed first.
1766
8e07c86e 1767=item make disttest
1768
1769Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
4633a7c4 1770a make test in that directory.
8e07c86e 1771
005c1a0e 1772=item make tardist
8e07c86e 1773
3b03c0f3 1774First does a distdir. Then a command $(PREOP) which defaults to a null
f1387719 1775command, followed by $(TOUNIX), which defaults to a null command under
1776UNIX, and will convert files in distribution directory to UNIX format
1777otherwise. Next it runs C<tar> on that directory into a tarfile and
3b03c0f3 1778deletes the directory. Finishes with a command $(POSTOP) which
1779defaults to a null command.
005c1a0e 1780
1781=item make dist
8e07c86e 1782
005c1a0e 1783Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1784
1785=item make uutardist
8e07c86e 1786
005c1a0e 1787Runs a tardist first and uuencodes the tarfile.
1788
1789=item make shdist
8e07c86e 1790
3b03c0f3 1791First does a distdir. Then a command $(PREOP) which defaults to a null
1792command. Next it runs C<shar> on that directory into a sharfile and
1793deletes the intermediate directory again. Finishes with a command
1794$(POSTOP) which defaults to a null command. Note: For shdist to work
1795properly a C<shar> program that can handle directories is mandatory.
1796
1797=item make zipdist
1798
1799First does a distdir. Then a command $(PREOP) which defaults to a null
1800command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1801zipfile. Then deletes that directory. Finishes with a command
1802$(POSTOP) which defaults to a null command.
005c1a0e 1803
1804=item make ci
8e07c86e 1805
1806Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1807
1808=back
005c1a0e 1809
1810Customization of the dist targets can be done by specifying a hash
1811reference to the dist attribute of the WriteMakefile call. The
1812following parameters are recognized:
1813
8e07c86e 1814 CI ('ci -u')
005c1a0e 1815 COMPRESS ('compress')
005c1a0e 1816 POSTOP ('@ :')
8e07c86e 1817 PREOP ('@ :')
f1387719 1818 TO_UNIX (depends on the system)
8e07c86e 1819 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1820 SHAR ('shar')
1821 SUFFIX ('Z')
1822 TAR ('tar')
1823 TARFLAGS ('cvf')
3b03c0f3 1824 ZIP ('zip')
1825 ZIPFLAGS ('-r')
005c1a0e 1826
1827An example:
1828
1829 WriteMakefile( 'dist' => { COMPRESS=>"gzip", SUFFIX=>"gz" })
1830
f1387719 1831=head1 SEE ALSO
1832
1833ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
1834ExtUtils::Install, ExtUtils::embed
005c1a0e 1835
e05e23b1 1836=head1 AUTHORS
fed7345c 1837
1838Andy Dougherty F<E<lt>doughera@lafcol.lafayette.eduE<gt>>, Andreas
8e07c86e 1839KE<ouml>nig F<E<lt>A.Koenig@franz.ww.TU-Berlin.DEE<gt>>, Tim Bunce
fed7345c 1840F<E<lt>Tim.Bunce@ig.co.ukE<gt>>. VMS support by Charles Bailey
a5f75d66 1841F<E<lt>bailey@genetics.upenn.eduE<gt>>. OS/2 support by Ilya
e05e23b1 1842Zakharevich F<E<lt>ilya@math.ohio-state.eduE<gt>>. Contact the
1843makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1844you have any questions.
fed7345c 1845
005c1a0e 1846=cut