diff options
author | Karl Williamson <public@khwilliamson.com> | 2013-01-24 14:41:02 -0700 |
---|---|---|
committer | Karl Williamson <public@khwilliamson.com> | 2013-01-24 19:04:48 -0700 |
commit | f703fc96a75eab3db924e41a52531905784836de (patch) | |
tree | 3e1d1202c4d1a4efaa959f0af21a57e7babfcacd /pod | |
parent | e58c5aaf5fae1951e56c0433da91fbbfb31b620c (diff) | |
download | perl-f703fc96a75eab3db924e41a52531905784836de.tar.gz |
Fix various minor pod issues
These were all uncovered by the new Pod::Checker, not yet in core.
Fixing these will speed up debugging the new Checker.
Diffstat (limited to 'pod')
-rw-r--r-- | pod/perldiag.pod | 2 | ||||
-rw-r--r-- | pod/perlfunc.pod | 22 | ||||
-rw-r--r-- | pod/perlgpl.pod | 100 | ||||
-rw-r--r-- | pod/perlguts.pod | 2 | ||||
-rw-r--r-- | pod/perlintro.pod | 2 | ||||
-rw-r--r-- | pod/perlmodinstall.pod | 2 | ||||
-rw-r--r-- | pod/perlop.pod | 4 | ||||
-rw-r--r-- | pod/perlpod.pod | 4 | ||||
-rw-r--r-- | pod/perlpragma.pod | 26 |
9 files changed, 82 insertions, 82 deletions
diff --git a/pod/perldiag.pod b/pod/perldiag.pod index fadbbad65a..02c93cebb0 100644 --- a/pod/perldiag.pod +++ b/pod/perldiag.pod @@ -671,7 +671,7 @@ Something like this will reproduce the error: =item Can't chdir to %s -(F) You called C<perl -x/foo/bar>, but C</foo/bar> is not a directory +(F) You called C<perl -x/foo/bar>, but F</foo/bar> is not a directory that you can chdir to, possibly because it doesn't exist. =item Can't check filesystem of script "%s" for nosuid diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod index cdae29fa66..0263deb9a1 100644 --- a/pod/perlfunc.pod +++ b/pod/perlfunc.pod @@ -4688,7 +4688,7 @@ an explicit repeat count for pack, the packed string is adjusted to that length. For example: This code: gives this result: - + unpack("W/a", "\004Gurusamy") ("Guru") unpack("a3/A A*", "007 Bond J ") (" Bond", "J") unpack("a3 x2 /A A*", "007: Bond, J.") ("Bond, J", ".") @@ -6616,32 +6616,32 @@ Examples: # sort lexically @articles = sort @files; - + # same thing, but with explicit sort routine @articles = sort {$a cmp $b} @files; - + # now case-insensitively @articles = sort {fc($a) cmp fc($b)} @files; - + # same thing in reversed order @articles = sort {$b cmp $a} @files; - + # sort numerically ascending @articles = sort {$a <=> $b} @files; - + # sort numerically descending @articles = sort {$b <=> $a} @files; - + # this sorts the %age hash by value instead of key # using an in-line function @eldest = sort { $age{$b} <=> $age{$a} } keys %age; - + # sort using explicit subroutine name sub byage { $age{$a} <=> $age{$b}; # presuming numeric } @sortedclass = sort byage @class; - + sub backwards { $b cmp $a } @harry = qw(dog cat x Cain Abel); @george = qw(gone chased yz Punished Axed); @@ -6692,11 +6692,11 @@ Examples: # not set here package main; @new = sort other::backwards @old; - + # guarantee stability, regardless of algorithm use sort 'stable'; @new = sort { substr($a, 3, 5) cmp substr($b, 3, 5) } @old; - + # force use of mergesort (not portable outside Perl 5.8) use sort '_mergesort'; # note discouraging _ @new = sort { substr($a, 3, 5) cmp substr($b, 3, 5) } @old; diff --git a/pod/perlgpl.pod b/pod/perlgpl.pod index 82a8f5a9dd..cd8a1d6434 100644 --- a/pod/perlgpl.pod +++ b/pod/perlgpl.pod @@ -35,15 +35,15 @@ For the Perl Artistic License, see L<perlartistic>. GNU GENERAL PUBLIC LICENSE Version 1, February 1989 - + Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - + Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - + Preamble - + The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free @@ -51,41 +51,41 @@ For the Perl Artistic License, see L<perlartistic>. General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. - + When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. - + To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. - + For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. - + We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. - + Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. - + The precise terms and conditions for copying, distribution and modification follow. - + GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - + 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The @@ -93,7 +93,7 @@ For the Perl Artistic License, see L<perlartistic>. on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". - + 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and @@ -102,21 +102,21 @@ For the Perl Artistic License, see L<perlartistic>. other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. - + 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: - + a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and - + b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). - + c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an @@ -125,34 +125,34 @@ For the Perl Artistic License, see L<perlartistic>. warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. - + d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. - + Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. - + 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: - + a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, - + b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, - + c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) - + Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special @@ -160,7 +160,7 @@ For the Perl Artistic License, see L<perlartistic>. libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. - + 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer @@ -169,22 +169,22 @@ For the Perl Artistic License, see L<perlartistic>. copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. - + 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. - + 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. - + 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. - + Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions @@ -192,7 +192,7 @@ For the Perl Artistic License, see L<perlartistic>. Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. - + 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free @@ -200,9 +200,9 @@ For the Perl Artistic License, see L<perlartistic>. make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. - + NO WARRANTY - + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES @@ -212,7 +212,7 @@ For the Perl Artistic License, see L<perlartistic>. TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - + 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, @@ -222,67 +222,67 @@ For the Perl Artistic License, see L<perlartistic>. YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - + END OF TERMS AND CONDITIONS - + Appendix: How to Apply These Terms to Your New Programs - + If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. - + To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. - + <one line to give the program's name and a brief idea of what it does.> Copyright (C) 19yy <name of author> - + This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. - + 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 the GNU General Public License for more details. - + You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA - - + + Also add information on how to contact you by electronic and paper mail. - + If the program is interactive, make it output a short notice like this when it starts in an interactive mode: - + Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free software, and you are welcome to redistribute it under certain conditions; type 'show c' for details. - + The hypothetical commands 'show w' and 'show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than 'show w' and 'show c'; they could even be mouse-clicks or menu items--whatever suits your program. - + You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: - + Yoyodyne, Inc., hereby disclaims all copyright interest in the program 'Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. - + <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice - + That's all there is to it! =cut diff --git a/pod/perlguts.pod b/pod/perlguts.pod index 52a0170c8d..4fb9ce1289 100644 --- a/pod/perlguts.pod +++ b/pod/perlguts.pod @@ -1536,7 +1536,7 @@ But it also puts the same information in certain fields of the XSUB itself: const char *subname = SvPVX(cv); STRLEN name_length = SvCUR(cv); /* in bytes */ U32 is_utf8 = SvUTF8(cv); - + C<SvPVX(cv)> contains just the sub name itself, not including the package. For an AUTOLOAD routine in UNIVERSAL or one of its superclasses, C<CvSTASH(cv)> returns NULL during a method call on a nonexistent package. diff --git a/pod/perlintro.pod b/pod/perlintro.pod index afce360a2a..2a090a60b6 100644 --- a/pod/perlintro.pod +++ b/pod/perlintro.pod @@ -70,7 +70,7 @@ Alternatively, put this as the first line of your script: #!/usr/bin/env perl -... and run the script as C</path/to/script.pl>. Of course, it'll need +... and run the script as F</path/to/script.pl>. Of course, it'll need to be executable first, so C<chmod 755 script.pl> (under Unix). (This start line assumes you have the B<env> program. You can also put diff --git a/pod/perlmodinstall.pod b/pod/perlmodinstall.pod index 9e88606ff5..be0608316e 100644 --- a/pod/perlmodinstall.pod +++ b/pod/perlmodinstall.pod @@ -53,7 +53,7 @@ module into your system's repository of Perl modules, but you can install modules into any directory you wish. For instance, where I say C<perl Makefile.PL>, you can substitute C<perl Makefile.PL PREFIX=/my/perl_directory> to install the modules into -C</my/perl_directory>. Then you can use the modules from your Perl +F</my/perl_directory>. Then you can use the modules from your Perl programs with C<use lib "/my/perl_directory/lib/site_perl";> or sometimes just C<use "/my/perl_directory";>. If you're on a system that requires superuser/root access to install modules into the diff --git a/pod/perlop.pod b/pod/perlop.pod index d0cfd85669..40402becae 100644 --- a/pod/perlop.pod +++ b/pod/perlop.pod @@ -561,7 +561,7 @@ the table is sorted on the right operand instead of on the left. like: exists HASH->{Any} Right operand is CODE: - + Left Right Description and pseudocode =============================================================== ARRAY CODE sub returns true on all ARRAY elements[1] @@ -2139,7 +2139,7 @@ X<qx> X<`> X<``> X<backtick> =item `STRING` A string which is (possibly) interpolated and then executed as a -system command with C</bin/sh> or its equivalent. Shell wildcards, +system command with F</bin/sh> or its equivalent. Shell wildcards, pipes, and redirections will be honored. The collected standard output of the command is returned; standard error is unaffected. In scalar context, it comes back as a single (potentially multi-line) diff --git a/pod/perlpod.pod b/pod/perlpod.pod index 7afb325c0c..a5cd12bcf1 100644 --- a/pod/perlpod.pod +++ b/pod/perlpod.pod @@ -291,9 +291,9 @@ module. Examples: =encoding utf8 =encoding koi8-r - + =encoding ShiftJIS - + =encoding big5 =back diff --git a/pod/perlpragma.pod b/pod/perlpragma.pod index 604387d9f9..78dacbf174 100644 --- a/pod/perlpragma.pod +++ b/pod/perlpragma.pod @@ -16,22 +16,22 @@ mathematical operators, and would like to provide your own pragma that functions much like C<use integer;> You'd like this code use MyMaths; - + my $l = MyMaths->new(1.2); my $r = MyMaths->new(3.4); - + print "A: ", $l + $r, "\n"; - + use myint; print "B: ", $l + $r, "\n"; - + { no myint; print "C: ", $l + $r, "\n"; } - + print "D: ", $l + $r, "\n"; - + no myint; print "E: ", $l + $r, "\n"; @@ -63,12 +63,12 @@ this: $$l + $$r; } }; - + sub new { my ($class, $value) = @_; bless \$value, $class; } - + 1; Note how we load the user pragma C<myint> with an empty list C<()> to @@ -77,24 +77,24 @@ prevent its C<import> being called. The interaction with the Perl compilation happens inside package C<myint>: package myint; - + use strict; use warnings; - + sub import { $^H{"myint/in_effect"} = 1; } - + sub unimport { $^H{"myint/in_effect"} = 0; } - + sub in_effect { my $level = shift // 0; my $hinthash = (caller($level))[10]; return $hinthash->{"myint/in_effect"}; } - + 1; As pragmata are implemented as modules, like any other module, C<use myint;> |