NAME

Module::Build::Compat - Compatibility with ExtUtils::MakeMaker

SYNOPSIS

 Here's a Makefile.PL that passes all functionality through to Module::Build
 
  use Module::Build::Compat;
  Module::Build::Compat->run_build_pl(args => \@ARGV);
  Module::Build::Compat->write_makefile();

DESCRIPTION

This module helps you build a Makefile.PL that passes all functionality through to Module::Build.

There are (at least) two good ways to distribute a module that can be installed using either perl Build.PL; Build; ... or perl Makefile.PL; make; .... For each way, you include both a Makefile.PL and a Build.PL script with your distribution. The difference is in whether the Makefile.PL is a pass-through to Module::Build actions, or a normal ExtUtils::MakeMaker-using script. If it's the latter, you don't need this module - but you'll have to maintain both the Build.PL and Makefile.PL scripts, and things like the prerequisite lists and any other customization duplicated in the scripts will probably become a pain in the ass.

For this reason, you might require that the user have Module::Build installed, and then the make commands just pass through to the corresponding Module::Build actions. That's what this module lets you do.

A typical Makefile.PL is shown above in SYNOPSIS. See also FALLBACK for some code that can help if the user doesn't have Module::Build installed yet.

So, some common scenarios are:

1. 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.
2. Include a Build.PL script and a "regular" Makefile.PL. This will make things easiest for your users, but hardest for you, as you try to maintain two separate installation scripts.
3. 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, but it's a little clumsy and there may be holes in the pass-through stuff I haven't thought of. You may also include the code in FALLBACK in your Makefile.PL.

METHODS

run_build_pl()

This method runs the Build.PL script, passing it any arguments the user may have supplied to the perl Makefile.PL command. 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:

  • args

    The args parameter specifies the parameters that would usually appear on the command line of the perl Makefile.PL command - typically you'll just pass a reference to @ARGV.

  • script

    This is the filename of the script to run - it defaults to Build.PL.

write_makefile()

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:

  • makefile

    The name of the file to write - defaults to the string Makefile.

FALLBACK

You may be wondering what happens when the user doesn't already have Module::Build installed - in this case, the installation process is going to fail until they install it. Fortunately, if the user is using CPAN.pm, we can exploit its prerequisite mechanism in order to get Module::Build installed. Amazingly, CPAN.pm actually reads the PREREQ_PM information from a comment in the generated Makefile. Therefore, the following Makefile.PL may be useful (make certain you preserve tabs!):

 -------------------------------------------------------------
 unless ( eval {require Module::Build::Compat} ) {
   # The user doesn't have Module::Build installed.  Put it as a 
   # prereq in the Makefile, so that CPAN.pm will install it.
 
   open MAKE, ">Makefile" or die "Cannot write Makefile: $!";
   print MAKE <<EOF;
 #      PREREQ_PM => { Module::Build=>q[0.05] }
 all : .DEFAULT
 
 .DEFAULT :
        \@echo "  This module requires Module::Build to test and install."
        \@echo "  Please install Module::Build first, then re-run 'perl Makefile.PL'."
 EOF
   close MAKE;
   exit 0;
 }
 
 # The user *does* have Module::Build installed.  Run Build.PL and make a pass-through Makefile.
 Module::Build::Compat->run_build_pl(args => \@ARGV);
 Module::Build::Compat->write_makefile;
 -------------------------------------------------------------

AUTHOR

Ken Williams, ken@mathforum.org

SEE ALSO

Module::Build(3), ExtUtils::MakeMaker(3)