X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Flocal%2Flib.pm;h=a5fd0cf91ce16c129f0085bbff4ea4636de31dfa;hb=7fc36986db1689d18df428d8124d495136ef06f4;hp=671c0fce633b60e830db32b751d0ced86d9048d6;hpb=b10fc4d414d5d2690a391f56b6d221c4af254d74;p=p5sagit%2Flocal-lib.git diff --git a/lib/local/lib.pm b/lib/local/lib.pm old mode 100644 new mode 100755 index 671c0fc..a5fd0cf --- a/lib/local/lib.pm +++ b/lib/local/lib.pm @@ -11,14 +11,12 @@ use File::Path (); use Carp (); use Config; -our $VERSION = '1.005000'; # 1.5.0 -my @KNOWN_FLAGS = (qw/--self-contained/); +our $VERSION = '1.006002'; # 1.6.2 + +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} || ''; @@ -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,8 +332,8 @@ 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), + $class->install_base_perl_path($path), (($ENV{PERL5LIB}||()) ? ($interpolate == INTERPOLATE_ENV ? ($ENV{PERL5LIB}) @@ -379,10 +363,14 @@ ok(-f 't/var/splat/.modulebuildrc'); =end testing +=encoding utf8 + =head1 NAME local::lib - create and use a local lib/ for perl modules with PERL5LIB +L + =head1 SYNOPSIS In code - @@ -397,11 +385,8 @@ In code - From the shell - - # Install LWP and its 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 +400,14 @@ 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 privileges, you will still want to set up your +environment variables, as discussed in step 4. Without this, you would still +install the modules into the system CPAN installation and also your Perl scripts +will not use the lib/ path you bootstrapped with local::lib. + +Windows users must also 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 @@ -429,12 +421,19 @@ convenient location. If the system asks you whether it should automatically configure as much as possible, you would typically answer yes. -3. Run this: +In order to install local::lib into a directory other than default, you need +to give that directory on the call of bootstrap like this: + + perl Makefile.PL --bootstrap=~/foo + +3. Run this: (local::lib assumes you have make installed on your system) make test && make install -4. Arrange for Perl to use your own packages instead of the system -packages. If you are using bash, you can do this as follows: +4. Now we need to setup the appropriate environment variables, so that Perl +starts using our newly generated lib/ directory. If you are using bash or +any other Bourne shells, you can add this to your shell startup script this +way: echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc @@ -445,17 +444,14 @@ If you are using C shell, you can do this as follows: /bin/csh perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc -You can also pass --bootstrap=~/foo to get a different location - - - perl Makefile.PL --bootstrap=~/foo - make test && make install +If you passed to bootstrap a directory other than default, you also need to give that as +import parameter to the call of the local::lib module like this way: echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc After writing your shell configuration file, be sure to re-read it to get the -changed settings into your current shell's environment. Bourne shells use C<. -~/.bashrc> for this, whereas C shells use C. Replace .bashrc or -.cshrc with the name of the file you wrote above with the echo command. +changed settings into your current shell's environment. Bourne shells use +C<. ~/.bashrc> for this, whereas C shells use C. If you're on a slower machine, or are operating under draconian disk space limitations, you can disable the automatic generation of manpages from POD when @@ -463,13 +459,15 @@ 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 development, -install local::lib globally and then: +To avoid doing several bootstrap for several Perl module environments on the +same account, for example if you use it for several different deployed +applications independently, you can use one bootstrapped local::lib +installation to install modules in different directories directly this way: cd ~/mydir1 perl -Mlocal::lib=./ eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone - printenv ### You will see that ~/mydir1 is in the PERL5LIB + printenv ### You will see that ~/mydir1 is in the PERL5LIB perl -MCPAN -e install ... ### whatever modules you want cd ../mydir2 ... REPEAT ... @@ -492,18 +490,21 @@ 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 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH% - ### To set the environment for this shell alone + ### To set the environment for this shell alone C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat ### 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" @@ -569,23 +570,9 @@ 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. +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 @@ -790,11 +777,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 . @@ -812,6 +794,12 @@ 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