Bug #39644 for local-lib: PATCH: add "--self-contained" option for generating self-contained dependency chains

Here's a revised patch that adds a warning clause refactor as you see fit.

--- /usr/local/share/perl/5.8.8/local/lib.pm 2008-08-06 06:52:36.000000000 -0400 +++ lib.pm 2008-12-04 20:40:41.000000000 -0500 @@ -14,9 +14,24 @@ our $VERSION = '1.002000'; # 1.2.0 sub import { - my ($class, $path) = @_; + my ($class, @args) = @_; + + # The path is required, but last in the list, so we pop, not shift here. + my $path = pop @args; $path = $class->resolve_path($path); $class->setup_local_lib_for($path); + + # Handle the '--self-contained' option + my $flag = shift @args; + no warnings 'uninitialized'; # the flag is optional + if ($flag eq '--self-contained') { + # The only directories that remain are those that we just defined and those where core modules are stored. + @INC = ($Config::Config{privlibexp}, $Config::Config{archlibexp}, split ':', $ENV{PERL5LIB}); + } + elsif (defined $flag) { + die "unrecognized import argument: $flag"; + } + } sub pipeline; @@ -306,6 +321,13 @@ From the shell - + # Install LWP and it's missing dependencies to the 'my_lwp' directory + perl -MCPAN -Mlocal::lib=my_lwp -e 'install LWP' + + # Install LWP and *all non-core* dependencies to the 'my_lwp' directory + perl -MCPAN -Mlocal::lib=--self-contained,my_lwp -e 'install LWP' + + # Just print out useful shell commands $ perl -Mlocal::lib export MODULEBUILDRC=/home/username/perl/.modulebuildrc export PERL_MM_OPT='INSTALL_BASE=/home/username/perl' @@ -365,6 +387,16 @@ These values are then available for reference by any code after import. +=head1 A WARNING ABOUT UNINST=1 + +Be careful about using local::lib in combination with "make install UNINST=1". +The idea of this feature is that will uninstall an old version of a module +before installing a new one. However it lacks a safety check that the old +version and the new version will go in the same directory. Used in combination +with local::lib, you can potentially delete a globally accessible version of a +module while installing the new version in a local place. Only combine if "make +install UNINST=1" and local::lib if you understand these possible consequences. + =head1 LIMITATIONS Rather basic shell detection. Right now anything with csh in its name is @@ -403,6 +435,8 @@ Patches to correctly output commands for csh style shells, as well as some documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>. +'--self-contained' feature contributed by Mark Stosberg <mark@summersault.com>. + =head1 LICENSE This library is free software under the same license as perl itself

Matt Trout provided me a gentle reminder that the docs for --self- contained could more comprehensive. Attached is a doc-patch to extend the documentation for that feature.

--- /usr/local/share/perl/5.10.0/local/lib.pm 2009-11-07 20:27:23.000000000 -0500 +++ lib.pm 2010-02-12 13:25:27.276990466 -0500 @@ -585,6 +585,26 @@ These values are then available for reference by any code after import. +=head1 CREATING A SELF-CONTAINED SET OF MODULES + +You can use local::lib to prepare a directory which contains a module and all +of its non-core dependencies. The C<--self-contained> option ignores any +globally installed modules when resolving dependencies, only considering +modules installed in a "local::lib" directory or provided by core Perl. + +A use-case for this feature would be to prepare to deploy a whole "stack" of +module dependencies on a new machine, even if you have copies of the same +dependencies installed globally already. + +The C<--self-contained> option should be used like this: + + # Install LWP and *all non-core* dependencies to the 'my_lwp' directory + perl -MCPAN -Mlocal::lib=--self-contained,my_lwp -e 'CPAN::install(LWP)' + +Note that some dependencies may involve C-based "XS" code even if your target +module doesn't. The issue of dealing with XS vs Pure Perl code is beyond the scope +of what local::lib provides. + =head1 METHODS =head2 ensure_directory_structure_for