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