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