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