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 => 'passthrough' ); ...
Because ExtUtils::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 working Makefile.PL in every distribution they download from CPAN. If you want to throw them a bone, you can use Module::Build::Compat to automatically generate a Makefile.PL for you, in one of several different styles.
Module::Build::Compat also provides some code that helps out the Makefile.PL at runtime.
- create_makefile_pl( $style, $build )
Creates a Makefile.PL in the current directory in one of several styles, based on the supplied Module::Build object
$build. This is typically controlled by passing the desired style as the
create_makefile_plparameter to Module::Build's
new()method; the Makefile.PL will then be automatically created during the
The currently supported styles are:
A small Makefile.PL will be created that passes all functionality through to the Build.PL script in the same directory. The user must already have Module::Build installed in order to use this, or else they'll get a module-not-found error.
This is just like the
smalloption above, but if Module::Build is not already installed on the user's system, the script will offer to use
CPAN.pmto download it and install it before continuing with the build.
A Makefile.PL will be created in the "traditional" style, i.e. it will use
ExtUtils::MakeMakerand won't rely on
Module::Buildat all. In order to create the Makefile.PL, we'll include the
build_requiresdependencies as the
You don't want to use this style if during the
perl Build.PLstage you ask the user questions, or do some auto-sensing about the user's environment, or if you subclass Module::Build to do some customization, because the vanilla Makefile.PL won't do any of that.
- run_build_pl( args => \@ARGV )
This method runs the Build.PL script, passing it any arguments the user may have supplied to the
perl Makefile.PLcommand. Because ExtUtils::MakeMaker and Module::Build accept different arguments, this method also performs some translation between the two.
run_build_pl()accepts the following named parameters:
argsparameter specifies the parameters that would usually appear on the command line of the
perl Makefile.PLcommand - typically you'll just pass a reference to
This is the filename of the script to run - it defaults to
This method writes a 'dummy' Makefile that will pass all commands through to the corresponding Module::Build actions.
write_makefile()accepts the following named parameters:
The name of the file to write - defaults to the string
So, some common scenarios are:
Just include a Build.PL script (without a Makefile.PL script), and give installation directions in a README or INSTALL document explaining how to install the module. In particular, explain that the user must install Module::Build before installing your module. I prefer this method, mainly because I believe that the woes and hardships of doing this are far less significant than most people would have you believe. It's also the simplest method, which is nice. But anyone with an older version of CPAN or CPANPLUS on their system will probably have problems installing your module with it.
Include a Build.PL script and a "traditional" Makefile.PL, created either manually or with create_makefile_pl(). Users won't ever have to install Module::Build, but in truth it's difficult to create a proper Makefile.PL
Include a Build.PL script and a "pass-through" Makefile.PL built using Module::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.
Ken Williams, email@example.com