X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit%2Flocal-lib.git;a=blobdiff_plain;f=lib%2Flocal%2Flib.pm;h=27f04152953c606a7911c3c8de3999733a04dae8;hp=cd243b921b9b0bda61ce856e036bdabb2d77ebea;hb=f174527120eb6638c937c8fc2bcdfa6648e0bca1;hpb=322b0a0d666bdc535683d60f48de723124437950 diff --git a/lib/local/lib.pm b/lib/local/lib.pm index cd243b9..27f0415 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.007000'; # 1.7.0 + +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}); @@ -215,11 +199,6 @@ sub setup_local_lib_for { } } -sub modulebuildrc_path { - my ($class, $path) = @_; - File::Spec->catfile($path, '.modulebuildrc'); -} - sub install_base_bin_path { my ($class, $path) = @_; File::Spec->catdir($path, 'bin'); @@ -244,20 +223,6 @@ sub ensure_dir_structure_for { # Need to have the path exist to make a short name for it, so # converting to a short name here. $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32'; - my $modulebuildrc_path = $class->modulebuildrc_path($path); - if (-e $modulebuildrc_path) { - unless (-f _) { - Carp::croak("${modulebuildrc_path} exists but is not a plain file"); - } - } else { - warn "Attempting to create file ${modulebuildrc_path}\n"; - open MODULEBUILDRC, '>', $modulebuildrc_path - || Carp::croak("Couldn't open ${modulebuildrc_path} for writing: $!"); - print MODULEBUILDRC qq{install --install_base ${path}\n} - || Carp::croak("Couldn't write line to ${modulebuildrc_path}: $!"); - close MODULEBUILDRC - || Carp::croak("Couldn't close file ${modulebuildrc_path}: $@"); - } return $path; } @@ -265,16 +230,7 @@ sub ensure_dir_structure_for { sub INTERPOLATE_ENV () { 1 } sub LITERAL_ENV () { 0 } -sub print_environment_vars_for { - my ($class, $path) = @_; - my @envs = $class->build_environment_vars_for($path, LITERAL_ENV); - my $out = ''; - - # rather basic csh detection, goes on the assumption that something won't - # call itself csh unless it really is. also, default to bourne in the - # pathological situation where a user doesn't have $ENV{SHELL} defined. - # note also that shells with funny names, like zoid, are assumed to be - # bourne. +sub guess_shelltype { my $shellbin = 'sh'; if(defined $ENV{'SHELL'}) { my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'}); @@ -306,6 +262,21 @@ sub print_environment_vars_for { } }; } + return $shelltype; +} + +sub print_environment_vars_for { + my ($class, $path) = @_; + my @envs = $class->build_environment_vars_for($path, LITERAL_ENV); + my $out = ''; + + # rather basic csh detection, goes on the assumption that something won't + # call itself csh unless it really is. also, default to bourne in the + # pathological situation where a user doesn't have $ENV{SHELL} defined. + # note also that shells with funny names, like zoid, are assumed to be + # bourne. + + my $shelltype = $class->guess_shelltype; while (@envs) { my ($name, $value) = (shift(@envs), shift(@envs)); @@ -345,12 +316,12 @@ sub setup_env_hash_for { sub build_environment_vars_for { my ($class, $path, $interpolate) = @_; return ( - MODULEBUILDRC => $class->modulebuildrc_path($path), + PERL_MB_OPT => "--install_base ${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 +330,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%' )) ), ) @@ -375,10 +346,10 @@ $c->ensure_dir_structure_for('t/var/splat'); ok(-d 't/var/splat'); -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 @@ -397,25 +368,31 @@ 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 - export MODULEBUILDRC=/home/username/perl/.modulebuildrc - export PERL_MM_OPT='INSTALL_BASE=/home/username/perl' - export PERL5LIB='/home/username/perl/lib/perl5:/home/username/perl/lib/perl5/i386-linux' - export PATH="/home/username/perl/bin:$PATH" + export PERL_MB_OPT='--install_base /home/username/perl5' + export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5' + export PERL5LIB='/home/username/perl5/lib/perl5/i386-linux:/home/username/perl5/lib/perl5' + export PATH="/home/username/perl5/bin:$PATH" =head2 The bootstrapping technique 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. + +By default local::lib installs itself and the CPAN modules into ~/perl5. + +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 +406,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 the default, you need +to specify the name of the directory when you call bootstrap, as follows: + + 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,26 +429,30 @@ 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. + 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 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, -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 ... @@ -487,22 +475,25 @@ 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_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5 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" -(Windows Vista or later) unless $ENV{HOME} exists. After that, the home +(Windows Vista or later)) unless $ENV{HOME} exists. After that, the home directory is translated to a short name (which means the directory must exist) and the subdirectories are created. @@ -548,7 +539,7 @@ values: =over 4 -=item MODULEBUILDRC +=item PERL_MB_OPT =item PERL_MM_OPT @@ -562,13 +553,21 @@ 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 +=head2 ensure_dir_structure_for =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: None =back @@ -579,29 +578,48 @@ an exception on failure. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: None =back Prints to standard output the variables listed above, properly set to use the given path as the base directory. +=head2 build_environment_vars_for + +=over 4 + +=item Arguments: $path, $interpolate + +=item Return value: \%environment_vars + +=back + +Returns a hash with the variables listed above, properly set to use the +given path as the base directory. + =head2 setup_env_hash_for =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: None =back Constructs the C<%ENV> keys for the given path, by calling -C. +L. =head2 install_base_perl_path =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $install_base_perl_path =back @@ -613,7 +631,9 @@ path. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $install_base_arch_path =back @@ -626,7 +646,9 @@ C<$Config{archname}>. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $install_base_bin_path =back @@ -634,22 +656,13 @@ Returns a path describing where to install the executable programs for this local library installation. Based on the L method's return value, and appends the directory C. -=head2 modulebuildrc_path - -=over 4 - -=item Arguments: path - -=back - -Returns a path describing where to install the C<.modulebuildrc> file, based on -the given path. - =head2 resolve_empty_path =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $base_path =back @@ -660,7 +673,9 @@ installation. Defaults to C<~/perl5>. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $home_path =back @@ -671,7 +686,9 @@ for this purpose. If no definite answer is available, throws an exception. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $absolute_path =back @@ -681,7 +698,9 @@ Translates the given path into an absolute path. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $absolute_path =back @@ -706,6 +725,12 @@ install UNINST=1" and local::lib if you understand these possible consequences. =head1 LIMITATIONS +The perl toolchain is unable to handle directory names with spaces in it, +so you cant put your local::lib bootstrap into a directory with spaces. What +you can do is moving your local::lib to a directory with spaces B you +installed all modules inside your local::lib bootstrap. But be aware that you +cant update or install CPAN modules after the move. + Rather basic shell detection. Right now anything with csh in its name is assumed to be a C shell or something compatible, and everything else is assumed to be Bourne, except on Win32 systems. If the C environment variable is @@ -714,7 +739,7 @@ not set, a Bourne-compatible shell is assumed. Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you have CPANPLUS installed. -Kills any existing PERL5LIB, PERL_MM_OPT or MODULEBUILDRC. +Kills any existing PERL5LIB, PERL_MM_OPT or PERL_MB_OPT. Should probably auto-fixup CPAN config if not already done. @@ -754,6 +779,12 @@ On Win32 systems, C is also examined. =back +=head1 SUPPORT + +IRC: + + Join #local-lib on irc.perl.org. + =head1 AUTHOR Matt S Trout http://www.shadowcat.co.uk/ @@ -765,12 +796,8 @@ 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 +Doc patches for a custom local::lib directory, more cleanups in the english +documentation and a L contributed by Torsten Raudssus . Hans Dieter Pearcey sent in some additional tests for ensuring @@ -784,9 +811,27 @@ 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). + +Brazilian L and minor doc patches contributed by Breno +G. de Oliveira . + +=head1 COPYRIGHT + +Copyright (c) 2007 - 2010 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