X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Flocal%2Flib.pm;h=cbee5dae405825877e12029649da82e89ab7df0a;hb=adf315c350d17e2f931cec03be3f93d708056b63;hp=ab6bde7c855fee269c18c62ffc1b6d4517ce3c37;hpb=a8e981cfe0efc18a1287a1e4671f588241915f74;p=p5sagit%2Flocal-lib.git

diff --git a/lib/local/lib.pm b/lib/local/lib.pm
index ab6bde7..cbee5da 100755
--- a/lib/local/lib.pm
+++ b/lib/local/lib.pm
@@ -11,7 +11,7 @@ use File::Path ();
 use Carp ();
 use Config;
 
-our $VERSION = '1.006005'; # 1.6.5
+our $VERSION = '1.006007'; # 1.6.7
 
 our @KNOWN_FLAGS = qw(--self-contained);
 
@@ -508,7 +508,7 @@ Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
 
 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.
 
@@ -570,17 +570,19 @@ These values are then available for reference by any code after import.
 
 =head1 CREATING A SELF-CONTAINED SET OF MODULES
 
-See L<lib::core::only|lib::core::only> for one way to do this - but note that
+See L<lib::core::only> 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
 
@@ -591,29 +593,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<build_environment_vars_for>.
+L</build_environment_vars_for>.
 
 =head2 install_base_perl_path
 
 =over 4
 
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $install_base_perl_path
 
 =back
 
@@ -625,7 +646,9 @@ path.
 
 =over 4
 
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $install_base_arch_path
 
 =back
 
@@ -638,7 +661,9 @@ C<$Config{archname}>.
 
 =over 4
 
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $install_base_bin_path
 
 =back
 
@@ -650,7 +675,9 @@ return value, and appends the directory C<bin>.
 
 =over 4
 
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $modulebuildrc_path
 
 =back
 
@@ -661,7 +688,9 @@ the given path.
 
 =over 4
 
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $base_path
 
 =back
 
@@ -672,7 +701,9 @@ installation. Defaults to C<~/perl5>.
 
 =over 4
 
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $home_path
 
 =back
 
@@ -683,7 +714,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
 
@@ -693,7 +726,9 @@ Translates the given path into an absolute path.
 
 =over 4
 
-=item Arguments: path
+=item Arguments: $path
+
+=item Return value: $absolute_path
 
 =back
 
@@ -790,7 +825,7 @@ Patches to correctly output commands for csh style shells, as well as some
 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
 
 Doc patches for a custom local::lib directory, more cleanups in the english
-documentation and a german documentation contributed by Torsten Raudssus
+documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus
 <torsten@raudssus.de>.
 
 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
@@ -813,6 +848,9 @@ Mark Stosberg <mark@summersault.com> provided the code for the now deleted
 Documentation patches to make win32 usage clearer by
 David Mertens <dcmertens.perl@gmail.com> (run4flat).
 
+Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno
+G. de Oliveira <garu@cpan.org>.
+
 =head1 COPYRIGHT
 
 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as