diff options
author | Karl Williamson <khw@cpan.org> | 2016-03-11 14:43:33 -0700 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2016-03-11 14:49:26 -0700 |
commit | e46aa1ddb7d58d270bbc45cef016b0577cfdecaa (patch) | |
tree | 2c2bae16536e85b2786e98dda62579ffa5c90c27 /dist | |
parent | fa6c7d00a8b0cf48c0f78066f87065cfb43d601b (diff) | |
download | perl-e46aa1ddb7d58d270bbc45cef016b0577cfdecaa.tar.gz |
Fix various pod errors.
Mostly these are too long verbatim lines.
Diffstat (limited to 'dist')
-rw-r--r-- | dist/Module-CoreList/lib/Module/CoreList.pod | 13 | ||||
-rw-r--r-- | dist/Module-CoreList/lib/Module/CoreList/Utils.pm | 9 | ||||
-rw-r--r-- | dist/PathTools/lib/File/Spec/AmigaOS.pm | 5 | ||||
-rw-r--r-- | dist/SelfLoader/lib/SelfLoader.pm | 107 | ||||
-rw-r--r-- | dist/Storable/Storable.pm | 46 | ||||
-rw-r--r-- | dist/Thread-Queue/lib/Thread/Queue.pm | 44 | ||||
-rw-r--r-- | dist/Tie-File/lib/Tie/File.pm | 42 | ||||
-rw-r--r-- | dist/Tie-File/t/00_version.t | 2 | ||||
-rw-r--r-- | dist/Time-HiRes/HiRes.pm | 3 | ||||
-rw-r--r-- | dist/threads/lib/threads.pm | 13 |
10 files changed, 152 insertions, 132 deletions
diff --git a/dist/Module-CoreList/lib/Module/CoreList.pod b/dist/Module-CoreList/lib/Module/CoreList.pod index d8807bf8b4..0ab1f611d0 100644 --- a/dist/Module-CoreList/lib/Module/CoreList.pod +++ b/dist/Module-CoreList/lib/Module/CoreList.pod @@ -8,9 +8,14 @@ Module::CoreList - what modules shipped with versions of perl print $Module::CoreList::version{5.00503}{CPAN}; # prints 1.48 - print Module::CoreList->first_release('File::Spec'); # prints 5.00405 - print Module::CoreList->first_release_by_date('File::Spec'); # prints 5.005 - print Module::CoreList->first_release('File::Spec', 0.82); # prints 5.006001 + print Module::CoreList->first_release('File::Spec'); + # prints 5.00405 + + print Module::CoreList->first_release_by_date('File::Spec'); + # prints 5.005 + + print Module::CoreList->first_release('File::Spec', 0.82); + # prints 5.006001 if (Module::CoreList::is_core('File::Spec')) { print "File::Spec is a core module\n"; @@ -19,7 +24,7 @@ Module::CoreList - what modules shipped with versions of perl print join ', ', Module::CoreList->find_modules(qr/Data/); # prints 'Data::Dumper' print join ', ', - Module::CoreList->find_modules(qr/test::h.*::.*s/i, 5.008008); + Module::CoreList->find_modules(qr/test::h.*::.*s/i, 5.008008); # prints 'Test::Harness::Assert, Test::Harness::Straps' print join ", ", @{ $Module::CoreList::families{5.005} }; diff --git a/dist/Module-CoreList/lib/Module/CoreList/Utils.pm b/dist/Module-CoreList/lib/Module/CoreList/Utils.pm index a550da0568..a1148bac16 100644 --- a/dist/Module-CoreList/lib/Module/CoreList/Utils.pm +++ b/dist/Module-CoreList/lib/Module/CoreList/Utils.pm @@ -6,7 +6,7 @@ use vars qw[$VERSION %utilities]; use Module::CoreList; use Module::CoreList::TieHashDelta; -$VERSION = '5.20160228'; +$VERSION = '5.20160311'; sub utilities { my $perl = shift; @@ -1182,8 +1182,11 @@ Module::CoreList::Utils - what utilities shipped with versions of perl print $Module::CoreList::Utils::utilities{5.009003}{ptar}; # prints 1 - print Module::CoreList::Utils->first_release('corelist'); # prints 5.008009 - print Module::CoreList::Utils->first_release_by_date('corelist'); # prints 5.009002 + print Module::CoreList::Utils->first_release('corelist'); + # prints 5.008009 + + print Module::CoreList::Utils->first_release_by_date('corelist'); + # prints 5.009002 =head1 DESCRIPTION diff --git a/dist/PathTools/lib/File/Spec/AmigaOS.pm b/dist/PathTools/lib/File/Spec/AmigaOS.pm index 075c36acdb..9182d5e6cb 100644 --- a/dist/PathTools/lib/File/Spec/AmigaOS.pm +++ b/dist/PathTools/lib/File/Spec/AmigaOS.pm @@ -4,7 +4,7 @@ use strict; use vars qw(@ISA $VERSION); require File::Spec::Unix; -$VERSION = '3.63'; +$VERSION = ';.64'; $VERSION =~ tr/_//d; @ISA = qw(File::Spec::Unix); @@ -15,7 +15,8 @@ File::Spec::AmigaOS - File::Spec for AmigaOS =head1 SYNOPSIS - require File::Spec::AmigaOS; # Done automatically by File::Spec if needed + require File::Spec::AmigaOS; # Done automatically by File::Spec + # if needed =head1 DESCRIPTION diff --git a/dist/SelfLoader/lib/SelfLoader.pm b/dist/SelfLoader/lib/SelfLoader.pm index 586dc57621..e36cb923d9 100644 --- a/dist/SelfLoader/lib/SelfLoader.pm +++ b/dist/SelfLoader/lib/SelfLoader.pm @@ -2,7 +2,7 @@ package SelfLoader; use 5.008; use strict; use IO::Handle; -our $VERSION = "1.22"; +our $VERSION = "1.23"; # The following bit of eval-magic is necessary to make this work on # perls < 5.009005. @@ -395,54 +395,61 @@ can benefit from bug fixes. This package has the same copyright and license as the perl core: - Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, - 2000, 2001, 2002, 2003, 2004, 2005, 2006 by Larry Wall and others - - All rights reserved. - - This program is free software; you can redistribute it and/or modify - it under the terms of either: - - a) the GNU General Public License as published by the Free - Software Foundation; either version 1, or (at your option) any - later version, or - - b) the "Artistic License" which comes with this Kit. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either - the GNU General Public License or the Artistic License for more details. - - You should have received a copy of the Artistic License with this - Kit, in the file named "Artistic". If not, I'll be glad to provide one. - - You should also have received a copy of the GNU General Public License - along with this program in the file named "Copying". If not, write to the - Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, - MA 02110-1301, USA or visit their web page on the internet at - http://www.gnu.org/copyleft/gpl.html. - - For those of you that choose to use the GNU General Public License, - my interpretation of the GNU General Public License is that no Perl - script falls under the terms of the GPL unless you explicitly put - said script under the terms of the GPL yourself. Furthermore, any - object code linked with perl does not automatically fall under the - terms of the GPL, provided such object code only adds definitions - of subroutines and variables, and does not otherwise impair the - resulting interpreter from executing any standard Perl script. I - consider linking in C subroutines in this manner to be the moral - equivalent of defining subroutines in the Perl language itself. You - may sell such an object file as proprietary provided that you provide - or offer to provide the Perl source, as specified by the GNU General - Public License. (This is merely an alternate way of specifying input - to the program.) You may also sell a binary produced by the dumping of - a running Perl script that belongs to you, provided that you provide or - offer to provide the Perl source as specified by the GPL. (The - fact that a Perl interpreter and your code are in the same binary file - is, in this case, a form of mere aggregation.) This is my interpretation - of the GPL. If you still have concerns or difficulties understanding - my intent, feel free to contact me. Of course, the Artistic License - spells all this out for your protection, so you may prefer to use that. +Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, +2000, 2001, 2002, 2003, 2004, 2005, 2006 by Larry Wall and others + +All rights reserved. + +This program is free software; you can redistribute it and/or modify +it under the terms of either: + +=over 4 + +=item a) + +the GNU General Public License as published by the Free Software Foundation; +either version 1, or (at your option) any later version, or + +=item b) + +the "Artistic License" which comes with this Kit. + +=back + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either +the GNU General Public License or the Artistic License for more details. + +You should have received a copy of the Artistic License with this +Kit, in the file named "Artistic". If not, I'll be glad to provide one. + +You should also have received a copy of the GNU General Public License +along with this program in the file named "Copying". If not, write to the +Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, +MA 02110-1301, USA or visit their web page on the internet at +http://www.gnu.org/copyleft/gpl.html. + +For those of you that choose to use the GNU General Public License, +my interpretation of the GNU General Public License is that no Perl +script falls under the terms of the GPL unless you explicitly put +said script under the terms of the GPL yourself. Furthermore, any +object code linked with perl does not automatically fall under the +terms of the GPL, provided such object code only adds definitions +of subroutines and variables, and does not otherwise impair the +resulting interpreter from executing any standard Perl script. I +consider linking in C subroutines in this manner to be the moral +equivalent of defining subroutines in the Perl language itself. You +may sell such an object file as proprietary provided that you provide +or offer to provide the Perl source, as specified by the GNU General +Public License. (This is merely an alternate way of specifying input +to the program.) You may also sell a binary produced by the dumping of +a running Perl script that belongs to you, provided that you provide or +offer to provide the Perl source as specified by the GPL. (The +fact that a Perl interpreter and your code are in the same binary file +is, in this case, a form of mere aggregation.) This is my interpretation +of the GPL. If you still have concerns or difficulties understanding +my intent, feel free to contact me. Of course, the Artistic License +spells all this out for your protection, so you may prefer to use that. =cut diff --git a/dist/Storable/Storable.pm b/dist/Storable/Storable.pm index 0aa23ab559..c8f6db107d 100644 --- a/dist/Storable/Storable.pm +++ b/dist/Storable/Storable.pm @@ -22,7 +22,7 @@ package Storable; @ISA = qw(Exporter); use vars qw($canonical $forgive_me $VERSION); -$VERSION = '2.55'; +$VERSION = '2.56'; BEGIN { if (eval { local $SIG{__DIE__}; require Log::Agent; 1 }) { @@ -979,43 +979,43 @@ such. Here are some code samples showing a possible usage of Storable: - use Storable qw(store retrieve freeze thaw dclone); + use Storable qw(store retrieve freeze thaw dclone); - %color = ('Blue' => 0.1, 'Red' => 0.8, 'Black' => 0, 'White' => 1); + %color = ('Blue' => 0.1, 'Red' => 0.8, 'Black' => 0, 'White' => 1); - store(\%color, 'mycolors') or die "Can't store %a in mycolors!\n"; + store(\%color, 'mycolors') or die "Can't store %a in mycolors!\n"; - $colref = retrieve('mycolors'); - die "Unable to retrieve from mycolors!\n" unless defined $colref; - printf "Blue is still %lf\n", $colref->{'Blue'}; + $colref = retrieve('mycolors'); + die "Unable to retrieve from mycolors!\n" unless defined $colref; + printf "Blue is still %lf\n", $colref->{'Blue'}; - $colref2 = dclone(\%color); + $colref2 = dclone(\%color); - $str = freeze(\%color); - printf "Serialization of %%color is %d bytes long.\n", length($str); - $colref3 = thaw($str); + $str = freeze(\%color); + printf "Serialization of %%color is %d bytes long.\n", length($str); + $colref3 = thaw($str); which prints (on my machine): - Blue is still 0.100000 - Serialization of %color is 102 bytes long. + Blue is still 0.100000 + Serialization of %color is 102 bytes long. Serialization of CODE references and deserialization in a safe compartment: =for example begin - use Storable qw(freeze thaw); - use Safe; - use strict; - my $safe = new Safe; + use Storable qw(freeze thaw); + use Safe; + use strict; + my $safe = new Safe; # because of opcodes used in "use strict": - $safe->permit(qw(:default require)); - local $Storable::Deparse = 1; - local $Storable::Eval = sub { $safe->reval($_[0]) }; - my $serialized = freeze(sub { 42 }); - my $code = thaw($serialized); - $code->() == 42; + $safe->permit(qw(:default require)); + local $Storable::Deparse = 1; + local $Storable::Eval = sub { $safe->reval($_[0]) }; + my $serialized = freeze(sub { 42 }); + my $code = thaw($serialized); + $code->() == 42; =for example end diff --git a/dist/Thread-Queue/lib/Thread/Queue.pm b/dist/Thread-Queue/lib/Thread/Queue.pm index 5a031ff5bd..f1a08c73b1 100644 --- a/dist/Thread-Queue/lib/Thread/Queue.pm +++ b/dist/Thread-Queue/lib/Thread/Queue.pm @@ -3,7 +3,7 @@ package Thread::Queue; use strict; use warnings; -our $VERSION = '3.07'; +our $VERSION = '3.08'; $VERSION = eval $VERSION; use threads::shared 1.21; @@ -485,13 +485,14 @@ Sets the size of the queue. If set, calls to C<enqueue()> will block until the number of pending items in the queue drops below the C<limit>. The C<limit> does not prevent enqueuing items beyond that count: - my $q = Thread::Queue->new(1, 2); - $q->limit = 4; - $q->enqueue(3, 4, 5); # Does not block - $q->enqueue(6); # Blocks until at least 2 items are dequeued - - my $size = $q->limit; # Returns the current limit (may return 'undef') - $q->limit = 0; # Queue size is now unlimited + my $q = Thread::Queue->new(1, 2); + $q->limit = 4; + $q->enqueue(3, 4, 5); # Does not block + $q->enqueue(6); # Blocks until at least 2 items are + # dequeued + my $size = $q->limit; # Returns the current limit (may return + # 'undef') + $q->limit = 0; # Queue size is now unlimited =item ->end() @@ -513,14 +514,14 @@ To prevent the contents of a queue from being modified by another thread while it is being examined and/or changed, L<lock|threads::shared/"lock VARIABLE"> the queue inside a local block: - { - lock($q); # Keep other threads from changing the queue's contents - my $item = $q->peek(); - if ($item ...) { - ... - } - } - # Queue is now unlocked + { + lock($q); # Keep other threads from changing the queue's contents + my $item = $q->peek(); + if ($item ...) { + ... + } + } + # Queue is now unlocked =over @@ -593,11 +594,12 @@ of the queue (similar to C<dequeue_nb>) if the count overlaps the head of the queue from the specified position (i.e. if queue size + index + count is greater than zero): - $q->enqueue(qw/foo bar baz/); - my @nada = $q->extract(-6, 2); # Returns () - (3+(-6)+2) <= 0 - my @some = $q->extract(-6, 4); # Returns (foo) - (3+(-6)+4) > 0 - # Queue now contains: bar, baz - my @rest = $q->extract(-3, 4); # Returns (bar, baz) - (2+(-3)+4) > 0 + $q->enqueue(qw/foo bar baz/); + my @nada = $q->extract(-6, 2); # Returns () - (3+(-6)+2) <= 0 + my @some = $q->extract(-6, 4); # Returns (foo) - (3+(-6)+4) > 0 + # Queue now contains: bar, baz + my @rest = $q->extract(-3, 4); # Returns + # (bar, baz) - (2+(-3)+4) > 0 =back diff --git a/dist/Tie-File/lib/Tie/File.pm b/dist/Tie-File/lib/Tie/File.pm index df8a197867..d546b81f44 100644 --- a/dist/Tie-File/lib/Tie/File.pm +++ b/dist/Tie-File/lib/Tie/File.pm @@ -7,7 +7,7 @@ use Fcntl 'O_CREAT', 'O_RDWR', 'LOCK_EX', 'LOCK_SH', 'O_WRONLY', 'O_RDONLY'; sub O_ACCMODE () { O_RDONLY | O_RDWR | O_WRONLY } -$VERSION = "1.01"; +$VERSION = "1.02"; my $DEFAULT_MEMORY_SIZE = 1<<21; # 2 megabytes my $DEFAULT_AUTODEFER_THRESHHOLD = 3; # 3 records my $DEFAULT_AUTODEFER_FILELEN_THRESHHOLD = 65536; # 16 disk blocksful @@ -2013,32 +2013,32 @@ Tie::File - Access the lines of a disk file via a Perl array =head1 SYNOPSIS - # This file documents Tie::File version 0.98 - use Tie::File; + # This file documents Tie::File version 0.98 + use Tie::File; - tie @array, 'Tie::File', filename or die ...; + tie @array, 'Tie::File', filename or die ...; - $array[13] = 'blah'; # line 13 of the file is now 'blah' - print $array[42]; # display line 42 of the file + $array[13] = 'blah'; # line 13 of the file is now 'blah' + print $array[42]; # display line 42 of the file - $n_recs = @array; # how many records are in the file? - $#array -= 2; # chop two records off the end + $n_recs = @array; # how many records are in the file? + $#array -= 2; # chop two records off the end - for (@array) { - s/PERL/Perl/g; # Replace PERL with Perl everywhere in the file - } + for (@array) { + s/PERL/Perl/g; # Replace PERL with Perl everywhere in the file + } - # These are just like regular push, pop, unshift, shift, and splice - # Except that they modify the file in the way you would expect + # These are just like regular push, pop, unshift, shift, and splice + # Except that they modify the file in the way you would expect - push @array, new recs...; - my $r1 = pop @array; - unshift @array, new recs...; - my $r2 = shift @array; - @old_recs = splice @array, 3, 7, new recs...; + push @array, new recs...; + my $r1 = pop @array; + unshift @array, new recs...; + my $r2 = shift @array; + @old_recs = splice @array, 3, 7, new recs...; - untie @array; # all finished + untie @array; # all finished =head1 DESCRIPTION @@ -2174,8 +2174,8 @@ The default memory limit is 2Mib. You can adjust the maximum read cache size by supplying the C<memory> option. The argument is the desired cache size, in bytes. - # I have a lot of memory, so use a large cache to speed up access - tie @array, 'Tie::File', $file, memory => 20_000_000; + # I have a lot of memory, so use a large cache to speed up access + tie @array, 'Tie::File', $file, memory => 20_000_000; Setting the memory limit to 0 will inhibit caching; records will be fetched from disk every time you examine them. diff --git a/dist/Tie-File/t/00_version.t b/dist/Tie-File/t/00_version.t index 1bd714ec0c..3a404ff38c 100644 --- a/dist/Tie-File/t/00_version.t +++ b/dist/Tie-File/t/00_version.t @@ -2,7 +2,7 @@ print "1..1\n"; -my $testversion = "1.01"; +my $testversion = "1.02"; use Tie::File; if ($Tie::File::VERSION != $testversion) { diff --git a/dist/Time-HiRes/HiRes.pm b/dist/Time-HiRes/HiRes.pm index ebd084e7e4..289ee06c89 100644 --- a/dist/Time-HiRes/HiRes.pm +++ b/dist/Time-HiRes/HiRes.pm @@ -120,7 +120,8 @@ Time::HiRes - High resolution alarm, sleep, gettimeofday, interval timers getitimer ($which); use Time::HiRes qw( clock_gettime clock_getres clock_nanosleep - ITIMER_REAL ITIMER_VIRTUAL ITIMER_PROF ITIMER_REALPROF ); + ITIMER_REAL ITIMER_VIRTUAL ITIMER_PROF + ITIMER_REALPROF ); $realtime = clock_gettime(CLOCK_REALTIME); $resolution = clock_getres(CLOCK_REALTIME); diff --git a/dist/threads/lib/threads.pm b/dist/threads/lib/threads.pm index 1a6316f64a..f4dee58fd6 100644 --- a/dist/threads/lib/threads.pm +++ b/dist/threads/lib/threads.pm @@ -363,10 +363,10 @@ If you add the C<stringify> import option to your C<use threads> declaration, then using a threads object in a string or a string context (e.g., as a hash key) will cause its ID to be used as the value: - use threads qw(stringify); + use threads qw(stringify); - my $thr = threads->create(...); - print("Thread $thr started...\n"); # Prints out: Thread 1 started... + my $thr = threads->create(...); + print("Thread $thr started...\n"); # Prints: Thread 1 started... =item threads->object($tid) @@ -691,15 +691,16 @@ threaded applications. To specify a particular stack size for any individual thread, call C<-E<gt>create()> with a hash reference as the first argument: - my $thr = threads->create({'stack_size' => 32*4096}, \&foo, @args); + my $thr = threads->create({'stack_size' => 32*4096}, \&foo, @args); =item $thr2 = $thr1->create(FUNCTION, ARGS) This creates a new thread (C<$thr2>) that inherits the stack size from an existing thread (C<$thr1>). This is shorthand for the following: - my $stack_size = $thr1->get_stack_size(); - my $thr2 = threads->create({'stack_size' => $stack_size}, FUNCTION, ARGS); + my $stack_size = $thr1->get_stack_size(); + my $thr2 = threads->create({'stack_size' => $stack_size}, + FUNCTION, ARGS); =back |