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=d2e526931e7b47b10e15c0801f5cefbebfbbb5ac;hp=79f8476badc9f19b0dc7e38c4c6317f9e8e44d4a;hb=be160790d81b3298b2378a9a55960685be078c67;hpb=381738d793482a098b86e2e530c452f93325d7fe diff --git a/lib/local/lib.pm b/lib/local/lib.pm index 79f8476..d2e5269 100644 --- a/lib/local/lib.pm +++ b/lib/local/lib.pm @@ -11,7 +11,7 @@ use File::Path (); use Carp (); use Config; -our $VERSION = '1.003000'; # 1.2.0 +our $VERSION = '1.003004'; # 1.3.4 sub import { my ($class, @args) = @_; @@ -24,6 +24,17 @@ sub import { # Handle the '--self-contained' option my $flag = shift @args; no warnings 'uninitialized'; # the flag is optional + # make sure fancy dashes cause an error + if ($flag =~ /−/) { + die <<'DEATH'; +WHOA THERE! It looks like you've got some fancy dashes in your commandline! +These are *not* the traditional -- dashes that software recognizes. You +probably got these by copy-pasting from the perldoc for this module as +rendered by a UTF8-capable formatter. This most typically happens on an OS X +terminal, but can happen elsewhere too. Please try again after replacing the +dashes with normal minus signs. +DEATH + } 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}); @@ -350,8 +361,38 @@ To bootstrap if you don't have local::lib itself installed - /bin/csh % perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc -You can also pass --boostrap=~/foo to get a different location (adjust the -bashrc / cshrc line appropriately) +You can also pass --boostrap=~/foo to get a different location - + + $ perl Makefile.PL --bootstrap=~/foo + $ make test && make install + + $ echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc + +If you want to install multiple Perl module environments, say for application evelopment, +install local::lib globally and then: + + $ 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 + $ perl -MCPAN -e install ... ### whatever modules you want + $ cd ../mydir2 + ... REPEAT ... + +For multiple environments for multiple apps you may need to include a modified version of +the C<< use FindBin >> instructions in the "In code" sample above. If you did something like +the above, you have a set of Perl modules at C<< ~/mydir1/lib >>. If you have a script at +C<< ~/mydir1/scripts/myscript.pl >>, you need to tell it where to find the modules you installed +for it at C<< ~/mydir1/lib>>. + +In C<< ~/mydir1/scripts/myscript.pl >>: + + use strict; + use warnings; + use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib + use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib + +Put this before any BEGIN { ... } blocks that require the modules you installed. =head1 DESCRIPTION @@ -387,6 +428,138 @@ PATH is appended to, rather than clobbered. These values are then available for reference by any code after import. +=head1 METHODS + +=head2 ensure_directory_structure_for + +=over 4 + +=item Arguments: path + +=back + +Attempts to create the given path, and all required parent directories. Throws +an exception on failure. + +=head2 print_environment_vars_for + +=over 4 + +=item Arguments: path + +=back + +Prints to standard output 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 + +=back + +Constructs the C<%ENV> keys for the given path, by calling +C. + +=head2 install_base_perl_path + +=over 4 + +=item Arguments: path + +=back + +Returns a path describing where to install the Perl modules for this local +library installation. Appends the directories C and C to the given +path. + +=head2 install_base_arch_path + +=over 4 + +=item Arguments: path + +=back + +Returns a path describing where to install the architecture-specific Perl +modules for this local library installation. Based on the +L method's return value, and appends the value of +C<$Config{archname}>. + +=head2 install_base_bin_path + +=over 4 + +=item Arguments: path + +=back + +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 + +=back + +Builds and returns the base path into which to set up the local module +installation. Defaults to C<~/perl5>. + +=head2 resolve_home_path + +=over 4 + +=item Arguments: path + +=back + +Attempts to find the user's home directory. If installed, uses C +for this purpose. If no definite answer is available, throws an exception. + +=head2 resolve_relative_path + +=over 4 + +=item Arguments: path + +=back + +Translates the given path into an absolute path. + +=head2 resolve_path + +=over 4 + +=item Arguments: path + +=back + +Calls the following in a pipeline, passing the result from the previous to the +next, in an attempt to find where to configure the environment for a local +library installation: L, L, +L. Passes the given path argument to +L which then returns a result that is passed to +L, which then has its result passed to +L. The result of this final call is returned from +L. + =head1 A WARNING ABOUT UNINST=1 Be careful about using local::lib in combination with "make install UNINST=1". @@ -437,6 +610,12 @@ documentation additions, contributed by Christopher Nehren . '--self-contained' feature contributed by Mark Stosberg . +Doc patches for a custom local::lib patch contributed by Torsten Raudssus +. + +Hans Dieter Pearcey sent in some additional tests for ensuring +things will install properly. + =head1 LICENSE This library is free software under the same license as perl itself