Module::Build::Tiny(3pm) User Contributed Perl Documentation Module::Build::Tiny(3pm)NAME
Module::Build::Tiny - A tiny replacement for Module::Build
VERSION
version 0.034
SYNOPSIS
use Module::Build::Tiny;
Build_PL();
DESCRIPTION
Many Perl distributions use a Build.PL file instead of a Makefile.PL file to drive distribution configuration, build, test and
installation. Traditionally, Build.PL uses Module::Build as the underlying build system. This module provides a simple, lightweight,
drop-in replacement.
Whereas Module::Build has over 6,700 lines of code; this module has less than 120, yet supports the features needed by most distributions.
Supported
o Pure Perl distributions
o Building XS or C
o Recursive test files
o MYMETA
o Man page generation
o Generated code from PL files
Not Supported
o Dynamic prerequisites
o HTML documentation generation
o Extending Module::Build::Tiny
o Module sharedirs
Directory structure
Your .pm and .pod files must be in lib/. Any executables must be in script/. Test files must be in t/. Dist sharedirs must be in share/.
USAGE
These all work pretty much like their Module::Build equivalents.
perl Build.PL
Build [ build ]
Build test
Build install
This supports the following options:
o verbose
o install_base
o installdirs
o prefix
o install_path
o destdir
o uninst
o config
o pure-perl
o create_packlist
AUTHORING
This module doesn't support authoring. To develop modules using Module::Build::Tiny, usage of Dist::Zilla::Plugin::ModuleBuildTiny or
App::ModuleBuildTiny is recommended.
CONFIG FILE AND ENVIRONMENT
Options can be provided in the "PERL_MB_OPT" environment variable the same way they can with Module::Build. This should be done during the
configuration stage.
Incompatibilities
o Argument parsing
Module::Build has an extremely permissive way of argument handling, Module::Build::Tiny only supports a (sane) subset of that. In
particular, "./Build destdir=/foo" does not work, you will need to pass it as "./Build --destdir=/foo".
o .modulebuildrc
Module::Build::Tiny does not support .modulebuildrc files. In particular, this means that versions of local::lib older than 1.006008
may break. Upgrading it resolves this issue.
SEE ALSO
Module::Build
AUTHORS
o Leon Timmermans <leont@cpan.org>
o David Golden <dagolden@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Leon Timmermans, David Golden.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
perl v5.18.2 2014-01-21 Module::Build::Tiny(3pm)
Check Out this Related Man Page
Module::Build::Bundling(3pm) User Contributed Perl Documentation Module::Build::Bundling(3pm)NAME
Module::Build::Bundling - How to bundle Module::Build with a distribution
SYNOPSIS
# Build.PL
use inc::latest 'Module::Build';
Module::Build->new(
module_name => 'Foo::Bar',
license => 'perl',
)->create_build_script;
DESCRIPTION
WARNING -- THIS IS AN EXPERIMENTAL FEATURE
In order to install a distribution using Module::Build, users must have Module::Build available on their systems. There are two ways to do
this. The first way is to include Module::Build in the "configure_requires" metadata field. This field is supported by recent versions
CPAN and CPANPLUS and is a standard feature in the Perl core as of Perl 5.10.1. Module::Build now adds itself to "configure_requires" by
default.
The second way supports older Perls that have not upgraded CPAN or CPANPLUS and involves bundling an entire copy of Module::Build into the
distribution's "inc/" directory. This is the same approach used by Module::Install, a modern wrapper around ExtUtils::MakeMaker for
Makefile.PL based distributions.
The "trick" to making this work for Module::Build is making sure the highest version Module::Build is used, whether this is in "inc/" or
already installed on the user's system. This ensures that all necessary features are available as well as any new bug fixes. This is done
using the new inc::latest module.
A "normal" Build.PL looks like this (with only the minimum required fields):
use Module::Build;
Module::Build->new(
module_name => 'Foo::Bar',
license => 'perl',
)->create_build_script;
A "bundling" Build.PL replaces the initial "use" line with a nearly transparent replacement:
use inc::latest 'Module::Build';
Module::Build->new(
module_name => 'Foo::Bar',
license => 'perl',
)->create_build_script;
For authors, when "Build dist" is run, Module::Build will be automatically bundled into "inc" according to the rules for inc::latest.
For users, inc::latest will load the latest Module::Build, whether installed or bundled in "inc/".
BUNDLING OTHER CONFIGURATION DEPENDENCIES
The same approach works for other configuration dependencies -- modules that must be available for Build.PL to run. All other dependencies
can be specified as usual in the Build.PL and CPAN or CPANPLUS will install them after Build.PL finishes.
For example, to bundle the Devel::AssertOS::Unix module (which ensures a "Unix-like" operating system), one could do this:
use inc::latest 'Devel::AssertOS::Unix';
use inc::latest 'Module::Build';
Module::Build->new(
module_name => 'Foo::Bar',
license => 'perl',
)->create_build_script;
The "inc::latest" module creates bundled directories based on the packlist file of an installed distribution. Even though "inc::latest"
takes module name arguments, it is better to think of it as bundling and making available entire distributions. When a module is loaded
through "inc::latest", it looks in all bundled distributions in "inc/" for a newer module than can be found in the existing @INC array.
Thus, the module-name provided should usually be the "top-level" module name of a distribution, though this is not strictly required. For
example, Module::Build has a number of heuristics to map module names to packlists, allowing users to do things like this:
use inc::latest 'Devel::AssertOS::Unix';
even though Devel::AssertOS::Unix is contained within the Devel-CheckOS distribution.
At the current time, packlists are required. Thus, bundling dual-core modules, including Module::Build, may require a 'forced install'
over versions in the latest version of perl in order to create the necessary packlist for bundling. This limitation will hopefully be
addressed in a future version of Module::Build.
WARNING -- How to Manage Dependency Chains
Before bundling a distribution you must ensure that all prerequisites are also bundled and load in the correct order. For Module::Build
itself, this should not be necessary, but it is necessary for any other distribution. (A future release of Module::Build will hopefully
address this deficiency.)
For example, if you need "Wibble", but "Wibble" depends on "Wobble", your Build.PL might look like this:
use inc::latest 'Wobble';
use inc::latest 'Wibble';
use inc::latest 'Module::Build';
Module::Build->new(
module_name => 'Foo::Bar',
license => 'perl',
)->create_build_script;
Authors are strongly suggested to limit the bundling of additional dependencies if at all possible and to carefully test their distribution
tarballs on older versions of Perl before uploading to CPAN.
AUTHOR
David Golden <dagolden@cpan.org>
Development questions, bug reports, and patches should be sent to the Module-Build mailing list at <module-build@perl.org>.
Bug reports are also welcome at <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Build>.
SEE ALSO perl(1), inc::latest, Module::Build(3), Module::Build::API(3), Module::Build::Cookbook(3),
perl v5.14.2 2012-06-27 Module::Build::Bundling(3pm)