Module::Build::Compat(3) | User Contributed Perl Documentation | Module::Build::Compat(3) |
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' ); ...
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.
Note that "Module::Build::Compat" more often causes installation issues than solves them, and each of the three Makefile.PL generation styles has unique compatibility or functionality issues that are unlikely to be fixed. Thus, the use of this module and "create_makefile_pl" is discouraged.
The currently supported styles are:
You don't want to use this style if during the "perl Build.PL" stage 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. Many standard "Module::Build" features such as "test_requires" are also not supported.
This style attempts (with varying success) to translate the Makefile.PL protocol to Build.PL, and is unnecessary on any modern toolchain that recognizes "configure_requires" metadata described below, as Build.PL will be run by default in this case. See <https://rt.cpan.org/Public/Bug/Display.html?id=75936> for an example of the issues it may cause.
This option has been deprecated and may be removed in a future version of Module::Build. Modern CPAN.pm and CPANPLUS will recognize the "configure_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 includes "configure_requires" support. In the future, when "configure_requires" support is deemed sufficiently widespread, the "passthrough" style will be removed.
"run_build_pl()" accepts the following named parameters:
"write_makefile()" accepts the following named parameters:
So, some common scenarios are:
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 the Makefile.PL/"ExtUtils::MakeMaker" way of doing things.
For good measure, of course, test both the Makefile.PL and the Build.PL before shipping.
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.
Module::Build(3), ExtUtils::MakeMaker(3)
2024-04-13 | perl v5.34.0 |