Codex

inc::latest

Section: User Contributed Perl Documentation (3pm)

Updated: 2014-09-19

Index?action=index Return to Main Contents


NAME

inc::latest - use modules bundled in inc/ if they are newer than installed ones

SYNOPSIS

DESCRIPTION

The module helps bootstrap configure-time dependencies for CPAN distributions. These dependencies get bundled into the directory within a distribution and are used by Build.PL (or Makefile.PL).
Arguments to are module names that are checked against both the current array and against specially-named directories in . If the bundled version is newer than the installed one (or the module isn't installed, then, the bundled directory is added to the start of <@INC> and the module is loaded from there.
There are actually two variations of --- one for authors and one for the directory. For distribution authors, the installed in the system will record modules loaded via and can be used to create the bundled files in , including writing the second variation as .
This second is the one that is loaded in a distribution being installed (e.g. from Build.PL). This bundled is the one that determines which module to load.

Special notes on bundling

The module creates bundled directories based on the packlist file of an installed distribution. Even though takes module name arguments, it is better to think of it as bundling and making available entire distributions. When a module is loaded through , it looks in all bundled distributions in for a newer module than can be found in the existing 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:

even though Devel::AssertOS::Unix is contained within the Devel-CheckOS distribution.

At the current time, packlists are required. Thus, bundling dual-core modules may require a 'forced install' over versions in the latest version of perl in order to create the necessary packlist for bundling.

USAGE

When calling , the bundled takes a single module name and optional arguments to pass to that module's own import method.

Author-mode

You are in author-mode inc::latest if any of the Author-mode methods are available. For example:

loaded_modules()

This takes no arguments and always returns a list of module names requested for loading via ``use inc::latest 'MODULE''', regardless of whether the load was successful or not.

:

write()
This writes the bundled version of inc::latest to the directory name given as an argument. It almost all cases, it should be ' '.

:

bundle_module()
If corresponds to a packlist, then this function creates a specially-named directory in and copies all .pm files from the modlist to the new directory (which almost always should just be 'inc'). For example, if Foo::Bar is the name of the module, and is 'inc', then the directory would be 'inc/inc_Foo-Bar' and contain files like this:
Currently, must have a packlist. If this is not the case (e.g. for a dual-core module), then the bundling will fail. You may be able to create a packlist by forced installing the module on top of the version that came with core Perl.

:

As bundled in inc/

All methods are private. Only the method is public.

AUTHOR

Eric Wilhelm <[email protected]>, David Golden <[email protected]>

COPYRIGHT

Copyright (c) 2009 by Eric Wilhelm and David Golden

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

Module::Build


Index

NAME

SYNOPSIS

DESCRIPTION

Special notes on bundling

USAGE

Author-mode

As bundled in inc/

AUTHOR

COPYRIGHT

SEE ALSO