Subject: | lots of pod lint |
Lots of pod lint against podchecker in bleadperl fixed. (not quite
everything!)
Subject: | cpanpluspodlint.patch |
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Backend.pm CPANPLUS-0.9011/lib/CPANPLUS/Backend.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Backend.pm 2011-01-07 21:59:12.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Backend.pm 2011-01-23 12:42:51.000000000 +0000
@@ -1239,7 +1239,7 @@
file:///path/to/sources => file:///path/to/sources/packages.txt
http://example.com/sources => http://example.com/sources/packages.txt
ftp://example.com/sources => ftp://example.com/sources/packages.txt
-
+
The file C<packages.txt> simply holds a list of packages that can be found
under the root of the C<URI>. This file can be automatically generated for
you when the remote source is a C<file:// URI>. For C<http://>, C<ftp://>,
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Config.pm CPANPLUS-0.9011/lib/CPANPLUS/Config.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Config.pm 2011-01-07 21:59:12.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Config.pm 2011-01-23 12:43:08.000000000 +0000
@@ -332,6 +332,7 @@
C<.tar.gz> files)
=cut
+
### if we dont have c::zlib, we'll need to use /bin/tar or we
### can not extract any files. Good time to change the default
$Conf->{'conf'}->{'prefer_bin'} =
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Configure.pm CPANPLUS-0.9011/lib/CPANPLUS/Configure.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Configure.pm 2011-01-07 21:59:12.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Configure.pm 2011-01-23 12:45:29.000000000 +0000
@@ -70,14 +70,18 @@
invoke the C<new> method, but instead retrieve the desired object via
a method call on a C<CPANPLUS::Backend> object.
+=over 4
+
=item load_configs
Controls whether or not additional user configurations are to be loaded
or not. Defaults to C<true>.
+=back
+
=cut
-### store teh CPANPLUS::Config object in a closure, so we only
+### store the CPANPLUS::Config object in a closure, so we only
### initialize it once.. otherwise, on a 2nd ->new, settings
### from configs on top of this one will be reset
{ my $Config;
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Dist/Autobundle.pm CPANPLUS-0.9011/lib/CPANPLUS/Dist/Autobundle.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Dist/Autobundle.pm 2009-05-27 20:18:53.000000000 +0100
+++ CPANPLUS-0.9011/lib/CPANPLUS/Dist/Autobundle.pm 2011-01-23 12:47:46.000000000 +0000
@@ -16,7 +16,7 @@
$modobj = $cb->parse_module( module => 'file://path/to/Snapshot_XXYY.pm' );
$modobj->install;
-
+
=head1 DESCRIPTION
C<CPANPLUS::Dist::Autobundle> is a distribution class for installing installation
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Dist/Base.pm CPANPLUS-0.9011/lib/CPANPLUS/Dist/Base.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Dist/Base.pm 2011-01-07 21:59:12.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Dist/Base.pm 2011-01-23 12:47:35.000000000 +0000
@@ -97,14 +97,14 @@
object, which you might do as follows:
$dist->status->mk_accessors( qw[my_implementation_accessor] );
-
+
The C<status> object is implemented as an instance of the
C<Object::Accessor> class. Please refer to its documentation for
details.
-
+
Return true if the initialization was successful, and false if it was
not.
-
+
The C<CPANPLUS::Dist::Base> implementation does not alter your object
and always returns true.
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Dist/MM.pm CPANPLUS-0.9011/lib/CPANPLUS/Dist/MM.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Dist/MM.pm 2011-01-07 21:59:12.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Dist/MM.pm 2011-01-23 12:47:00.000000000 +0000
@@ -32,7 +32,7 @@
$mm->create; # runs make && make test
$mm->install; # runs make install
-
+
=head1 DESCRIPTION
C<CPANPLUS::Dist::MM> is a distribution class for MakeMaker related
@@ -154,7 +154,9 @@
return 1;
}
-=pod $bool = $dist->init();
+=pod
+
+=head2 $bool = $dist->init();
Sets up the C<CPANPLUS::Dist::MM> object for use.
Effectively creates all the needed status accessors.
@@ -174,7 +176,9 @@
return 1;
}
-=pod $bool = $dist->prepare([perl => '/path/to/perl', makemakerflags => 'EXTRA=FLAGS', force => BOOL, verbose => BOOL])
+=pod
+
+=head2 $bool = $dist->prepare([perl => '/path/to/perl', makemakerflags => 'EXTRA=FLAGS', force => BOOL, verbose => BOOL])
C<prepare> preps a distribution for installation. This means it will
run C<perl Makefile.PL> and determine what prerequisites this distribution
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Error.pm CPANPLUS-0.9011/lib/CPANPLUS/Error.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Error.pm 2010-03-15 12:49:27.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Error.pm 2011-01-23 12:45:57.000000000 +0000
@@ -135,7 +135,10 @@
This is the filehandle all the messages sent to C<msg()> are being
printed. This default to C<*STDOUT>.
+=back
+
=cut
+
local $| = 1;
$ERROR_FH = \*STDERR;
$MSG_FH = \*STDOUT;
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Internals/Extract.pm CPANPLUS-0.9011/lib/CPANPLUS/Internals/Extract.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Internals/Extract.pm 2011-01-07 22:00:12.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Internals/Extract.pm 2011-01-23 12:44:20.000000000 +0000
@@ -36,12 +36,12 @@
It can do this by either a pure perl solution (preferred) with the
use of C<Archive::Tar> and C<Compress::Zlib>, or with binaries, like
C<gzip> and C<tar>.
-
+
The flow looks like this:
$cb->_extract
Delegate to Archive::Extract
-
+
=head1 METHODS
=head2 $dir = _extract( module => $modobj, [perl => '/path/to/perl', extractdir => '/path/to/extract/to', prefer_bin => BOOL, verbose => BOOL, force => BOOL] )
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Internals/Utils.pm CPANPLUS-0.9011/lib/CPANPLUS/Internals/Utils.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Internals/Utils.pm 2009-12-23 09:14:59.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Internals/Utils.pm 2011-01-23 12:43:52.000000000 +0000
@@ -238,7 +238,9 @@
return $contents;
}
-=pod $cb->_move( from => $file|$dir, to => $target );
+=pod
+
+=head2 $cb->_move( from => $file|$dir, to => $target );
Moves a file or directory to the target.
@@ -267,7 +269,9 @@
}
}
-=pod $cb->_copy( from => $file|$dir, to => $target );
+=pod
+
+=head2 $cb->_copy( from => $file|$dir, to => $target );
Moves a file or directory to the target.
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Internals.pm CPANPLUS-0.9011/lib/CPANPLUS/Internals.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Internals.pm 2011-01-07 22:05:38.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Internals.pm 2011-01-23 12:42:25.000000000 +0000
@@ -104,6 +104,7 @@
Returns the object on success, or dies on failure.
=cut
+
{ ### NOTE:
### if extra callbacks are added, don't forget to update the
### 02-internals.t test script with them!
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Module.pm CPANPLUS-0.9011/lib/CPANPLUS/Module.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Module.pm 2011-01-07 21:59:12.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS/Module.pm 2011-01-23 12:48:45.000000000 +0000
@@ -833,7 +833,7 @@
=pod
=head2 $bool = $mod->prepare( )
-
+
Convenience method around C<install()> that prepares a module
without actually building it. This is equivalent to invoking C<install>
with C<target> set to C<prepare>
@@ -1084,7 +1084,9 @@
return;
}
-=pod @list = $self->bundle_modules()
+=pod
+
+=head2 @list = $self->bundle_modules()
Returns a list of module objects the Bundle specifies.
@@ -1694,7 +1696,7 @@
started the program, by calling:
$self->parent->flush('lib');
-
+
=cut
sub add_to_includepath {
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Selfupdate.pm CPANPLUS-0.9011/lib/CPANPLUS/Selfupdate.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Selfupdate.pm 2010-06-08 14:35:43.000000000 +0100
+++ CPANPLUS-0.9011/lib/CPANPLUS/Selfupdate.pm 2011-01-23 12:40:46.000000000 +0000
@@ -236,7 +236,7 @@
sub list_categories { return sort keys %$cache }
=head2 %list = $self->list_modules_to_update( update => "core|dependencies|enabled_features|features|all", [latest => BOOL] )
-
+
List which modules C<selfupdate> would upgrade. You can update either
the core (CPANPLUS itself), the core dependencies, all features you have
currently turned on, or all features available, or everything.
@@ -244,16 +244,16 @@
The C<latest> option determines whether it should update to the latest
version on CPAN, or if the minimal required version for CPANPLUS is
good enough.
-
+
Returns a hash of feature names and lists of module objects to be
upgraded based on the category you provided. For example:
%list = $self->list_modules_to_update( update => 'core' );
-
+
Would return:
( core => [ $module_object_for_cpanplus ] );
-
+
=cut
sub list_modules_to_update {
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS/Shell/Default/Plugins/CustomSource.pm CPANPLUS-0.9011/lib/CPANPLUS/Shell/Default/Plugins/CustomSource.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS/Shell/Default/Plugins/CustomSource.pm 2009-05-27 20:18:53.000000000 +0100
+++ CPANPLUS-0.9011/lib/CPANPLUS/Shell/Default/Plugins/CustomSource.pm 2011-01-23 12:41:03.000000000 +0000
@@ -12,7 +12,7 @@
CPANPLUS::Shell::Default::Plugins::CustomSource
=head1 SYNOPSIS
-
+
### elaborate help text
CPAN Terminal> /? cs
diff -urN CPANPLUS-0.9011.orig/lib/CPANPLUS.pm CPANPLUS-0.9011/lib/CPANPLUS.pm
--- CPANPLUS-0.9011.orig/lib/CPANPLUS.pm 2011-01-07 22:05:38.000000000 +0000
+++ CPANPLUS-0.9011/lib/CPANPLUS.pm 2011-01-23 12:39:59.000000000 +0000
@@ -113,7 +113,7 @@
$ perl -MCPANPLUS -eshell
$ perl -MCPANPLUS -e'fetch Some::Module'
-
+
=head1 DESCRIPTION
The C<CPANPLUS> library is an API to the C<CPAN> mirrors and a
@@ -160,7 +160,7 @@
All commands available are listed in the interactive shells
help menu. See C<cpanp -h> or L<CPANPLUS::Shell::Default>
for instructions on using the default shell.
-
+
=head2 CHOOSE A SHELL
By running C<cpanp> without arguments, you will start up
@@ -173,7 +173,7 @@
You can start this shell by typing:
$ perl -MCPANPLUS -e'shell Classic'
-
+
Even more shells may be available from C<CPAN>.
Note that if you have changed your default shell in your
@@ -188,8 +188,8 @@
for example C<.deb> or C<FreeBSD ports>.
See C<cpan2dist -h> for details.
-
-
+
+
=head1 FUNCTIONS
For quick access to common commands, you may use this module,