Edit File: ExtUtils::MakeMaker::FAQ.3pm
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" ======================================================================== .\" .IX Title "ExtUtils::MakeMaker::FAQ 3" .TH ExtUtils::MakeMaker::FAQ 3 "2014-12-02" "perl v5.10.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" ExtUtils::MakeMaker::FAQ \- Frequently Asked Questions About MakeMaker .SH "DESCRIPTION" .IX Header "DESCRIPTION" FAQs, tricks and tips for \f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR. .SS "Module Installation" .IX Subsection "Module Installation" .IP "How do I install a module into my home directory?" 4 .IX Item "How do I install a module into my home directory?" If you're not the Perl administrator you probably don't have permission to install a module to its default location. Then you should install it for your own use into your home directory like so: .Sp .Vb 2 \& # Non\-unix folks, replace ~ with /path/to/your/home/dir \& perl Makefile.PL INSTALL_BASE=~ .Ve .Sp This will put modules into \fI~/lib/perl5\fR, man pages into \fI~/man\fR and programs into \fI~/bin\fR. .Sp To ensure your Perl programs can see these newly installed modules, set your \f(CW\*(C`PERL5LIB\*(C'\fR environment variable to \fI~/lib/perl5\fR or tell each of your programs to look in that directory with the following: .Sp .Vb 1 \& use lib "$ENV{HOME}/lib/perl5"; .Ve .Sp or if \f(CW$ENV\fR{\s-1HOME\s0} isn't set and you don't want to set it for some reason, do it the long way. .Sp .Vb 1 \& use lib "/path/to/your/home/dir/lib/perl5"; .Ve .IP "How do I get MakeMaker and Module::Build to install to the same place?" 4 .IX Item "How do I get MakeMaker and Module::Build to install to the same place?" Module::Build, as of 0.28, supports two ways to install to the same location as MakeMaker. .Sp We highly recommend the install_base method, its the simplest and most closely approximates the expected behavior of an installation prefix. .Sp 1) Use \s-1INSTALL_BASE\s0 / \f(CW\*(C`\-\-install_base\*(C'\fR .Sp MakeMaker (as of 6.31) and Module::Build (as of 0.28) both can install to the same locations using the \*(L"install_base\*(R" concept. See \&\*(L"\s-1INSTALL_BASE\s0\*(R" in ExtUtils::MakeMaker for details. To get \s-1MM\s0 and \s-1MB\s0 to install to the same location simply set \s-1INSTALL_BASE\s0 in \s-1MM\s0 and \&\f(CW\*(C`\-\-install_base\*(C'\fR in \s-1MB\s0 to the same location. .Sp .Vb 2 \& perl Makefile.PL INSTALL_BASE=/whatever \& perl Build.PL \-\-install_base /whatever .Ve .Sp This works most like other language's behavior when you specify a prefix. We recommend this method. .Sp 2) Use \s-1PREFIX\s0 / \f(CW\*(C`\-\-prefix\*(C'\fR .Sp Module::Build 0.28 added support for \f(CW\*(C`\-\-prefix\*(C'\fR which works like MakeMaker's \s-1PREFIX\s0. .Sp .Vb 2 \& perl Makefile.PL PREFIX=/whatever \& perl Build.PL \-\-prefix /whatever .Ve .Sp We highly discourage this method. It should only be used if you know what you're doing and specifically need the \s-1PREFIX\s0 behavior. The \&\s-1PREFIX\s0 algorithm is complicated and focused on matching the system installation. .IP "How do I keep from installing man pages?" 4 .IX Item "How do I keep from installing man pages?" Recent versions of MakeMaker will only install man pages on Unix-like operating systems. .Sp For an individual module: .Sp .Vb 1 \& perl Makefile.PL INSTALLMAN1DIR=none INSTALLMAN3DIR=none .Ve .Sp If you want to suppress man page installation for all modules you have to reconfigure Perl and tell it 'none' when it asks where to install man pages. .IP "How do I use a module without installing it?" 4 .IX Item "How do I use a module without installing it?" Two ways. One is to build the module normally... .Sp .Vb 3 \& perl Makefile.PL \& make \& make test .Ve .Sp \&...and then set the \s-1PERL5LIB\s0 environment variable to point at the blib/lib and blib/arch directories. .Sp The other is to install the module in a temporary location. .Sp .Vb 4 \& perl Makefile.PL INSTALL_BASE=~/tmp \& make \& make test \& make install .Ve .Sp And then set \s-1PERL5LIB\s0 to \fI~/tmp/lib/perl5\fR. This works well when you have multiple modules to work with. It also ensures that the module goes through its full installation process which may modify it. .IP "\s-1PREFIX\s0 vs \s-1INSTALL_BASE\s0 from Module::Build::Cookbook" 4 .IX Item "PREFIX vs INSTALL_BASE from Module::Build::Cookbook" The behavior of \s-1PREFIX\s0 is complicated and depends closely on how your Perl is configured. The resulting installation locations will vary from machine to machine and even different installations of Perl on the same machine. Because of this, its difficult to document where prefix will place your modules. .Sp In contrast, \s-1INSTALL_BASE\s0 has predictable, easy to explain installation locations. Now that Module::Build and MakeMaker both have \s-1INSTALL_BASE\s0 there is little reason to use \s-1PREFIX\s0 other than to preserve your existing installation locations. If you are starting a fresh Perl installation we encourage you to use \s-1INSTALL_BASE\s0. If you have an existing installation installed via \s-1PREFIX\s0, consider moving it to an installation structure matching \s-1INSTALL_BASE\s0 and using that instead. .SS "Common errors and problems" .IX Subsection "Common errors and problems" .ie n .IP """No rule to make target `/usr/lib/perl5/CORE/config.h', needed by `Makefile'""" 4 .el .IP "``No rule to make target `/usr/lib/perl5/CORE/config.h', needed by `Makefile'''" 4 .IX Item "No rule to make target `/usr/lib/perl5/CORE/config.h', needed by `Makefile'" Just what it says, you're missing that file. MakeMaker uses it to determine if perl has been rebuilt since the Makefile was made. It's a bit of a bug that it halts installation. .Sp Some operating systems don't ship the \s-1CORE\s0 directory with their base perl install. To solve the problem, you likely need to install a perl development package such as perl-devel (CentOS, Fedora and other Redhat systems) or perl (Ubuntu and other Debian systems). .SS "Philosophy and History" .IX Subsection "Philosophy and History" .IP "Why not just use <insert other build config tool here>?" 4 .IX Item "Why not just use <insert other build config tool here>?" Why did MakeMaker reinvent the build configuration wheel? Why not just use autoconf or automake or ppm or Ant or ... .Sp There are many reasons, but the major one is cross-platform compatibility. .Sp Perl is one of the most ported pieces of software ever. It works on operating systems I've never even heard of (see perlport for details). It needs a build tool that can work on all those platforms and with any wacky C compilers and linkers they might have. .Sp No such build tool exists. Even make itself has wildly different dialects. So we have to build our own. .IP "What is Module::Build and how does it relate to MakeMaker?" 4 .IX Item "What is Module::Build and how does it relate to MakeMaker?" Module::Build is a project by Ken Williams to supplant MakeMaker. Its primary advantages are: .RS 4 .IP "\(bu" 8 pure perl. no make, no shell commands .IP "\(bu" 8 easier to customize .IP "\(bu" 8 cleaner internals .IP "\(bu" 8 less cruft .RE .RS 4 .Sp Module::Build was long the official heir apparent to MakeMaker. The rate of both its development and adoption has slowed in recent years, though, and it is unclear what the future holds for it. That said, Module::Build set the stage for \fIsomething\fR to become the heir to MakeMaker. MakeMaker's maintainers have long said that it is a dead end and should be kept functioning, but not extended with new features. It's complicated enough as it is! .RE .SS "Module Writing" .IX Subsection "Module Writing" .ie n .IP "How do I keep my $VERSION up to date without resetting it manually?" 4 .el .IP "How do I keep my \f(CW$VERSION\fR up to date without resetting it manually?" 4 .IX Item "How do I keep my $VERSION up to date without resetting it manually?" Often you want to manually set the \f(CW$VERSION\fR in the main module distribution because this is the version that everybody sees on \s-1CPAN\s0 and maybe you want to customize it a bit. But for all the other modules in your dist, \f(CW$VERSION\fR is really just bookkeeping and all that's important is it goes up every time the module is changed. Doing this by hand is a pain and you often forget. .Sp Simplest way to do it automatically is to use your version control system's revision number (you are using version control, right?). .Sp In \s-1CVS\s0, \s-1RCS\s0 and \s-1SVN\s0 you use \f(CW$Revision\fR$ (see the documentation of your version control system for details). Every time the file is checked in the \f(CW$Revision\fR$ will be updated, updating your \f(CW$VERSION\fR. .Sp \&\s-1SVN\s0 uses a simple integer for \f(CW$Revision\fR$ so you can adapt it for your \&\f(CW$VERSION\fR like so: .Sp .Vb 1 \& ($VERSION) = q$Revision$ =~ /(\ed+)/; .Ve .Sp In \s-1CVS\s0 and \s-1RCS\s0 version 1.9 is followed by 1.10. Since \s-1CPAN\s0 compares version numbers numerically we use a \fIsprintf()\fR to convert 1.9 to 1.009 and 1.10 to 1.010 which compare properly. .Sp .Vb 1 \& $VERSION = sprintf "%d.%03d", q$Revision$ =~ /(\ed+)\e.(\ed+)/g; .Ve .Sp If branches are involved (ie. \f(CW$Revision:\fR 1.5.3.4$) it's a little more complicated. .Sp .Vb 2 \& # must be all on one line or MakeMaker will get confused. \& $VERSION = do { my @r = (q$Revision$ =~ /\ed+/g); sprintf "%d."."%03d" x $#r, @r }; .Ve .Sp In \s-1SVN\s0, \f(CW$Revision\fR$ should be the same for every file in the project so they would all have the same \f(CW$VERSION\fR. \s-1CVS\s0 and \s-1RCS\s0 have a different \&\f(CW$Revision\fR$ per file so each file will have a different \f(CW$VERSION\fR. Distributed version control systems, such as \s-1SVK\s0, may have a different \&\f(CW$Revision\fR$ based on who checks out the file, leading to a different \f(CW$VERSION\fR on each machine! Finally, some distributed version control systems, such as darcs, have no concept of revision number at all. .IP "What's this \fI\s-1META\s0.yml\fR thing and how did it get in my \fI\s-1MANIFEST\s0\fR?!" 4 .IX Item "What's this META.yml thing and how did it get in my MANIFEST?!" \&\fI\s-1META\s0.yml\fR is a module meta-data file pioneered by Module::Build and automatically generated as part of the 'distdir' target (and thus \&'dist'). See \*(L"Module Meta-Data\*(R" in ExtUtils::MakeMaker. .Sp To shut off its generation, pass the \f(CW\*(C`NO_META\*(C'\fR flag to \f(CW\*(C`WriteMakefile()\*(C'\fR. .IP "How do I delete everything not in my \fI\s-1MANIFEST\s0\fR?" 4 .IX Item "How do I delete everything not in my MANIFEST?" Some folks are surprised that \f(CW\*(C`make distclean\*(C'\fR does not delete everything not listed in their \s-1MANIFEST\s0 (thus making a clean distribution) but only tells them what they need to delete. This is done because it is considered too dangerous. While developing your module you might write a new file, not add it to the \s-1MANIFEST\s0, then run a \f(CW\*(C`distclean\*(C'\fR and be sad because your new work was deleted. .Sp If you really want to do this, you can use \&\f(CW\*(C`ExtUtils::Manifest::manifind()\*(C'\fR to read the \s-1MANIFEST\s0 and File::Find to delete the files. But you have to be careful. Here's a script to do that. Use at your own risk. Have fun blowing holes in your foot. .Sp .Vb 1 \& #!/usr/bin/perl \-w \& \& use strict; \& \& use File::Spec; \& use File::Find; \& use ExtUtils::Manifest qw(maniread); \& \& my %manifest = map {( $_ => 1 )} \& grep { File::Spec\->canonpath($_) } \& keys %{ maniread() }; \& \& if( !keys %manifest ) { \& print "No files found in MANIFEST. Stopping.\en"; \& exit; \& } \& \& find({ \& wanted => sub { \& my $path = File::Spec\->canonpath($_); \& \& return unless \-f $path; \& return if exists $manifest{ $path }; \& \& print "unlink $path\en"; \& unlink $path; \& }, \& no_chdir => 1 \& }, \& "." \& ); .Ve .IP "Which tar should I use on Windows?" 4 .IX Item "Which tar should I use on Windows?" We recommend ptar from Archive::Tar not older than 1.66 with '\-C' option. .IP "Which zip should I use on Windows for '[nd]make zipdist'?" 4 .IX Item "Which zip should I use on Windows for '[nd]make zipdist'?" We recommend InfoZIP: <http://www.info\-zip.org/Zip.html> .SS "\s-1XS\s0" .IX Subsection "XS" .ie n .IP "How do I prevent ""object version X.XX does not match bootstrap parameter Y.YY"" errors?" 4 .el .IP "How do I prevent ``object version X.XX does not match bootstrap parameter Y.YY'' errors?" 4 .IX Item "How do I prevent object version X.XX does not match bootstrap parameter Y.YY errors?" \&\s-1XS\s0 code is very sensitive to the module version number and will complain if the version number in your Perl module doesn't match. If you change your module's version # without rerunning Makefile.PL the old version number will remain in the Makefile, causing the \s-1XS\s0 code to be built with the wrong number. .Sp To avoid this, you can force the Makefile to be rebuilt whenever you change the module containing the version number by adding this to your \&\fIWriteMakefile()\fR arguments. .Sp .Vb 1 \& depend => { \*(Aq$(FIRST_MAKEFILE)\*(Aq => \*(Aq$(VERSION_FROM)\*(Aq } .Ve .IP "How do I make two or more \s-1XS\s0 files coexist in the same directory?" 4 .IX Item "How do I make two or more XS files coexist in the same directory?" Sometimes you need to have two and more \s-1XS\s0 files in the same package. One way to go is to put them into separate directories, but sometimes this is not the most suitable solution. The following technique allows you to put two (and more) \s-1XS\s0 files in the same directory. .Sp Let's assume that we have a package \f(CW\*(C`Cool::Foo\*(C'\fR, which includes \&\f(CW\*(C`Cool::Foo\*(C'\fR and \f(CW\*(C`Cool::Bar\*(C'\fR modules each having a separate \s-1XS\s0 file. First we use the following \fIMakefile.PL\fR: .Sp .Vb 1 \& use ExtUtils::MakeMaker; \& \& WriteMakefile( \& NAME => \*(AqCool::Foo\*(Aq, \& VERSION_FROM => \*(AqFoo.pm\*(Aq, \& OBJECT => q/$(O_FILES)/, \& # ... other attrs ... \& ); .Ve .Sp Notice the \f(CW\*(C`OBJECT\*(C'\fR attribute. MakeMaker generates the following variables in \fIMakefile\fR: .Sp .Vb 7 \& # Handy lists of source code files: \& XS_FILES= Bar.xs \e \& Foo.xs \& C_FILES = Bar.c \e \& Foo.c \& O_FILES = Bar.o \e \& Foo.o .Ve .Sp Therefore we can use the \f(CW\*(C`O_FILES\*(C'\fR variable to tell MakeMaker to use these objects into the shared library. .Sp That's pretty much it. Now write \fIFoo.pm\fR and \fIFoo.xs\fR, \fIBar.pm\fR and \fIBar.xs\fR, where \fIFoo.pm\fR bootstraps the shared library and \&\fIBar.pm\fR simply loading \fIFoo.pm\fR. .Sp The only issue left is to how to bootstrap \fIBar.xs\fR. This is done from \fIFoo.xs\fR: .Sp .Vb 1 \& MODULE = Cool::Foo PACKAGE = Cool::Foo \& \& BOOT: \& # boot the second XS file \& boot_Cool_\|_Bar(aTHX_ cv); .Ve .Sp If you have more than two files, this is the place where you should boot extra \s-1XS\s0 files from. .Sp The following four files sum up all the details discussed so far. .Sp .Vb 3 \& Foo.pm: \& \-\-\-\-\-\-\- \& package Cool::Foo; \& \& require DynaLoader; \& \& our @ISA = qw(DynaLoader); \& our $VERSION = \*(Aq0.01\*(Aq; \& bootstrap Cool::Foo $VERSION; \& \& 1; \& \& Bar.pm: \& \-\-\-\-\-\-\- \& package Cool::Bar; \& \& use Cool::Foo; # bootstraps Bar.xs \& \& 1; \& \& Foo.xs: \& \-\-\-\-\-\-\- \& #include "EXTERN.h" \& #include "perl.h" \& #include "XSUB.h" \& \& MODULE = Cool::Foo PACKAGE = Cool::Foo \& \& BOOT: \& # boot the second XS file \& boot_Cool_\|_Bar(aTHX_ cv); \& \& MODULE = Cool::Foo PACKAGE = Cool::Foo PREFIX = cool_foo_ \& \& void \& cool_foo_perl_rules() \& \& CODE: \& fprintf(stderr, "Cool::Foo says: Perl Rules\en"); \& \& Bar.xs: \& \-\-\-\-\-\-\- \& #include "EXTERN.h" \& #include "perl.h" \& #include "XSUB.h" \& \& MODULE = Cool::Bar PACKAGE = Cool::Bar PREFIX = cool_bar_ \& \& void \& cool_bar_perl_rules() \& \& CODE: \& fprintf(stderr, "Cool::Bar says: Perl Rules\en"); .Ve .Sp And of course a very basic test: .Sp .Vb 9 \& t/cool.t: \& \-\-\-\-\-\-\-\- \& use Test; \& BEGIN { plan tests => 1 }; \& use Cool::Foo; \& use Cool::Bar; \& Cool::Foo::perl_rules(); \& Cool::Bar::perl_rules(); \& ok 1; .Ve .Sp This tip has been brought to you by Nick Ing-Simmons and Stas Bekman. .SH "PATCHING" .IX Header "PATCHING" If you have a question you'd like to see added to the \s-1FAQ\s0 (whether or not you have the answer) please send it to makemaker@perl.org. .SH "AUTHOR" .IX Header "AUTHOR" The denizens of makemaker@perl.org. .SH "SEE ALSO" .IX Header "SEE ALSO" ExtUtils::MakeMaker
Back to File Manager