Module::Build::Compat - Compatibility with ExtUtils::MakeMaker
# In a Build.PL :use Module::Build;my $build = Module::Build->new ( module_name => 'Foo::Bar', license => 'perl', create_makefile_pl => 'traditional' );...BecauseExtUtils::MakeMaker has been the standard way to distribute modules for a long time, many tools (CPAN.pm, or your system administrator) may expect to find a workingMakefile.PL in every distribution they download from CPAN. If you want to throw them a bone, you can useModule::Build::Compat to automatically generate aMakefile.PL for you, in one of several different styles.
Module::Build::Compat also provides some code that helps out theMakefile.PL at runtime.
Creates aMakefile.PL in the current directory in one of several styles, based on the suppliedModule::Build object$build. This is typically controlled by passing the desired style as thecreate_makefile_pl parameter toModule::Build'snew() method; theMakefile.PL will then be automatically created during thedistdir action.
The currently supported styles are:
AMakefile.PL will be created in the "traditional" style, i.e. it will useExtUtils::MakeMaker and won't rely onModule::Build at all. In order to create theMakefile.PL, we'll include therequires andbuild_requires dependencies as thePREREQ_PM parameter.
You don't want to use this style if during theperl Build.PL stage you ask the user questions, or do some auto-sensing about the user's environment, or if you subclassModule::Build to do some customization, because the vanillaMakefile.PL won't do any of that.
A smallMakefile.PL will be created that passes all functionality through to theBuild.PL script in the same directory. The user must already haveModule::Build installed in order to use this, or else they'll get a module-not-found error.
This is just like thesmall option above, but ifModule::Build is not already installed on the user's system, the script will offer to useCPAN.pm to download it and install it before continuing with the build.
This option has been deprecated and may be removed in a future version of Module::Build. Modern CPAN.pm and CPANPLUS will recognize theconfigure_requires metadata property and install Module::Build before running Build.PL if Module::Build is listed and Module::Build now adds itself to configure_requires by default.
Perl 5.10.1 includesconfigure_requires support. In the future, whenconfigure_requires support is deemed sufficiently widespread, thepassthrough style will be removed.
This method runs theBuild.PL script, passing it any arguments the user may have supplied to theperl Makefile.PL command. BecauseExtUtils::MakeMaker andModule::Build accept different arguments, this method also performs some translation between the two.
run_build_pl() accepts the following named parameters:
This method writes a 'dummy'Makefile that will pass all commands through to the correspondingModule::Build actions.
write_makefile() accepts the following named parameters:
The name of the file to write - defaults to the stringMakefile.
So, some common scenarios are:
Just include aBuild.PL script (without aMakefile.PL script), and give installation directions in aREADME orINSTALL document explaining how to install the module. In particular, explain that the user must installModule::Build before installing your module.
Note that if you do this, you may make things easier for yourself, but harder for people with older versions of CPAN or CPANPLUS on their system, because those tools generally only understand theMakefile.PL/ExtUtils::MakeMaker way of doing things.
Include aBuild.PL script and a "traditional"Makefile.PL, created either manually or withcreate_makefile_pl(). Users won't ever have to installModule::Build if they use theMakefile.PL, but they won't get to take advantage ofModule::Build's extra features either.
For good measure, of course, test both theMakefile.PL and theBuild.PL before shipping.
Include aBuild.PL script and a "pass-through"Makefile.PL built usingModule::Build::Compat. This will mean that people can continue to use the "old" installation commands, and they may never notice that it's actually doing something else behind the scenes. It will also mean that your installation process is compatible with older versions of tools like CPAN and CPANPLUS.
Ken Williams <kwilliams@cpan.org>
Copyright (c) 2001-2006 Ken Williams. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.
The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.