X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Flocal%2Flib.pm;h=96564d5bd686299315e68690c69702ebd9ac5e65;hb=76f30678a4173158aac658808b0a036f97be810a;hp=5830e855320de3bffc3c889fa9844e97dca8bc19;hpb=aab644814c49a1c0a3cfc7c058e6d33ab525151f;p=p5sagit%2Flocal-lib.git diff --git a/lib/local/lib.pm b/lib/local/lib.pm index 5830e85..96564d5 100644 --- a/lib/local/lib.pm +++ b/lib/local/lib.pm @@ -11,17 +11,15 @@ use File::Path (); use Carp (); use Config; -our $VERSION = '1.004007'; # 1.4.7 -my @KNOWN_FLAGS = (qw/--self-contained/); +our $VERSION = '1.005001'; # 1.5.1 + +our @KNOWN_FLAGS = qw(--self-contained); sub import { my ($class, @args) = @_; - @args <= 1 + @KNOWN_FLAGS or die <<'DEATH'; -Please see `perldoc local::lib` for directions on using this module. -DEATH # Remember what PERL5LIB was when we started - my $perl5lib = $ENV{PERL5LIB}; + my $perl5lib = $ENV{PERL5LIB} || ''; my %arg_store; for my $arg (@args) { @@ -50,21 +48,7 @@ DEATH } if($arg_store{'self-contained'}) { - # The only directories that remain are those that we just defined and those - # where core modules are stored. We put PERL5LIB first, so it'll be favored - # over privlibexp and archlibexp - - @INC = _uniq( - $class->install_base_perl_path($arg_store{path}), - $class->install_base_arch_path($arg_store{path}), - split( $Config{path_sep}, $perl5lib ), - $Config::Config{privlibexp}, - $Config::Config{archlibexp} - ); - - # We explicitly set PERL5LIB here to the above de-duped list to prevent - # @INC from growing with each invocation - $ENV{PERL5LIB} = join( $Config{path_sep}, @INC ); + die "FATAL: The local::lib --self-contained flag has never worked reliably and the original author, Mark Stosberg, was unable or unwilling to maintain it. As such, this flag has been removed from the local::lib codebase in order to prevent misunderstandings and potentially broken builds. The local::lib authors recommend that you look at the lib::core::only module shipped with this distribution in order to create a more robust environment that is equivalent to what --self-contained provided (although quite possibly not what you originally thought it provided due to the poor quality of the documentation, for which we apologise).\n"; } $arg_store{path} = $class->resolve_path($arg_store{path}); @@ -348,9 +332,9 @@ sub build_environment_vars_for { MODULEBUILDRC => $class->modulebuildrc_path($path), PERL_MM_OPT => "INSTALL_BASE=${path}", PERL5LIB => join($Config{path_sep}, - $class->install_base_perl_path($path), $class->install_base_arch_path($path), - ($ENV{PERL5LIB} ? + $class->install_base_perl_path($path), + (($ENV{PERL5LIB}||()) ? ($interpolate == INTERPOLATE_ENV ? ($ENV{PERL5LIB}) : (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' )) @@ -359,7 +343,7 @@ sub build_environment_vars_for { PATH => join($Config{path_sep}, $class->install_base_bin_path($path), ($interpolate == INTERPOLATE_ENV - ? $ENV{PATH} + ? ($ENV{PATH}||()) : (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' )) ), ) @@ -397,11 +381,8 @@ In code - From the shell - - # Install LWP and it's missing dependencies to the 'my_lwp' directory - perl -MCPAN -Mlocal::lib=my_lwp -e 'CPAN::install(LWP)' - - # Install LWP and *all non-core* dependencies to the 'my_lwp' directory - perl -MCPAN -Mlocal::lib=--self-contained,my_lwp -e 'CPAN::install(LWP)' + # Install LWP and its missing dependencies to the '~/perl5' directory + perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)' # Just print out useful shell commands $ perl -Mlocal::lib @@ -415,7 +396,9 @@ From the shell - A typical way to install local::lib is using what is known as the "bootstrapping" technique. You would do this if your system administrator hasn't already installed local::lib. In this case, you'll need to install -local::lib in your home directory. +local::lib in your home directory. If you do have administrative priveleges, +you will still want to set up your environment variables, as discussed in +step 4 (and for Windows users, see L). 1. Download and unpack the local::lib tarball from CPAN (search for "Download" on the CPAN page about local::lib). Do this as an ordinary user, not as root @@ -463,7 +446,7 @@ installing modules by using the C<--no-manpages> argument when bootstrapping: perl Makefile.PL --bootstrap --no-manpages -If you want to install multiple Perl module environments, say for application evelopment, +If you want to install multiple Perl module environments, say for application development, install local::lib globally and then: cd ~/mydir1 @@ -492,6 +475,9 @@ Put this before any BEGIN { ... } blocks that require the modules you installed. =head2 Differences when using this module under Win32 +To set up the proper environment variables for your current session of +C, you can use this: + C:\>perl -Mlocal::lib set MODULEBUILDRC=C:\DOCUME~1\ADMINI~1\perl5\.modulebuildrc set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5 @@ -503,7 +489,7 @@ Put this before any BEGIN { ... } blocks that require the modules you installed. ### instead of $(perl -Mlocal::lib=./) If you want the environment entries to persist, you'll need to add then to the -Control Panel's System applet yourself at the moment. +Control Panel's System applet yourself or use L. The "~" is translated to the user's profile directory (the directory named for the user under "Documents and Settings" (Windows XP or earlier) or "Users" @@ -567,6 +553,12 @@ PATH is appended to, rather than clobbered. These values are then available for reference by any code after import. +=head1 CREATING A SELF-CONTAINED SET OF MODULES + +See L for one way to do this - but note that +there are a number of caveats, and the best approach is always to perform a +build against a clean perl (i.e. site and vendor as close to empty as possible). + =head1 METHODS =head2 ensure_directory_structure_for @@ -770,11 +762,6 @@ auto_install fixes kindly sponsored by http://www.takkle.com/ Patches to correctly output commands for csh style shells, as well as some documentation additions, contributed by Christopher Nehren . -'--self-contained' feature contributed by Mark Stosberg . - -Ability to pass '--self-contained' without a directory inspired by frew on -irc.perl.org/#catalyst. - Doc patches for a custom local::lib directory contributed by Torsten Raudssus . @@ -789,9 +776,24 @@ section. Many thanks! Patch to add Win32 support contributed by Curtis Jewell . +Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced +by a patch from Marco Emilio Poleggi. + +Mark Stosberg provided the code for the now deleted +'--self-contained' option. + +Documentation patches to make win32 usage clearer by +David Mertens (run4flat). + +=head1 COPYRIGHT + +Copyright (c) 2007 - 2009 the local::lib L and L as +listed above. + =head1 LICENSE -This library is free software under the same license as perl itself. +This library is free software and may be distributed under the same terms +as perl itself. =cut