From: Jesse Vincent Date: Tue, 6 Oct 2009 03:42:38 +0000 (-0400) Subject: A number of pod fixes found by podcheck.t X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=345e23944176348809d2be92e05ba6856a5c0ebc;p=p5sagit%2Fp5-mst-13.2.git A number of pod fixes found by podcheck.t --- diff --git a/Porting/perldelta_template b/Porting/perldelta_template index effa536..484cc97 100644 --- a/Porting/perldelta_template +++ b/Porting/perldelta_template @@ -233,7 +233,7 @@ XXX Any changes specific to a particular platform. VMS and Win32 are the usual stars here. It's probably best to group changes under the same section layout as the main perldelta -=item Obituary +=head1 Obituary XXX If any significant core contributor has died, we've added a short obituary here. diff --git a/dist/ExtUtils-Install/lib/ExtUtils/Install.pm b/dist/ExtUtils-Install/lib/ExtUtils/Install.pm index c886c69..0928228 100644 --- a/dist/ExtUtils-Install/lib/ExtUtils/Install.pm +++ b/dist/ExtUtils-Install/lib/ExtUtils/Install.pm @@ -75,6 +75,8 @@ ocurred, but should not impact later operations. =begin _private +=over + =item _chmod($$;$) Wrapper to chmod() for debugging and error trapping. @@ -87,6 +89,8 @@ Warns about something only once. Dies with a special message. +=back + =end _private =cut @@ -169,6 +173,8 @@ sub _chmod($$;$) { =begin _private +=over + =item _move_file_at_boot( $file, $target, $moan ) OS-Specific, Win32/Cygwin @@ -235,6 +241,7 @@ sub _move_file_at_boot { #XXX OS-SPECIFIC =begin _private + =item _unlink_or_rename( $file, $tryhard, $installing ) OS-Specific, Win32/Cygwin @@ -262,6 +269,8 @@ a derivative of the original in the same directory) so that the caller can use it to install under. In all other cases of success returns $file. On failure throws a fatal error. +=back + =end _private =cut @@ -313,6 +322,8 @@ sub _unlink_or_rename { #XXX OS-SPECIFIC =begin _private +=over + =item _get_install_skip Handles loading the INSTALL.SKIP file. Returns an array of patterns to use. @@ -556,8 +567,6 @@ sub _chdir { =end _private -=over 4 - =item B # deprecated forms diff --git a/dist/ExtUtils-Install/lib/ExtUtils/Packlist.pm b/dist/ExtUtils-Install/lib/ExtUtils/Packlist.pm index 04f267a..9ff67f4 100644 --- a/dist/ExtUtils-Install/lib/ExtUtils/Packlist.pm +++ b/dist/ExtUtils-Install/lib/ExtUtils/Packlist.pm @@ -13,6 +13,8 @@ my $fhname = "FH1"; =begin _undocumented +=over + =item mkfh() Make a filehandle. Same kind of idea as Symbol::gensym(). @@ -34,6 +36,8 @@ time relative to $^X, and generates a regexp that matches them =end _undocumented +=back + =cut sub __find_relocations diff --git a/ext/B/B/Concise.pm b/ext/B/B/Concise.pm index 284f797..e1bf2af 100644 --- a/ext/B/B/Concise.pm +++ b/ext/B/B/Concise.pm @@ -1741,14 +1741,14 @@ This restores one of the standard line-styles: C, C, C, C, C, into effect. It also accepts style names previously defined with add_style(). -=head2 add_style() +=head2 add_style () This subroutine accepts a new style name and three style arguments as above, and creates, registers, and selects the newly named style. It is an error to re-add a style; call set_style_standard() to switch between several styles. -=head2 add_callback() +=head2 add_callback () If your newly minted styles refer to any new #variables, you'll need to define a callback subroutine that will populate (or modify) those diff --git a/ext/mro/mro.pm b/ext/mro/mro.pm index 07a4721..5acf0e5 100644 --- a/ext/mro/mro.pm +++ b/ext/mro/mro.pm @@ -131,7 +131,7 @@ Note that C (and any members of C's MRO) are not part of the MRO of a class, even though all classes implicitly inherit methods from C and its parents. -=head2 mro::set_mro($classname, $type) +=head2 mro::set_mro ($classname, $type) Sets the MRO of the given class to the C<$type> argument (either C or C). @@ -328,9 +328,13 @@ works (like C); =back -=head2 The Pugs prototype Perl 6 Object Model uses C3 +=head2 Pugs -=head2 Parrot now uses C3 +The Pugs prototype Perl 6 Object Model uses C3 + +=head2 Parrot + +Parrot now uses C3 =over 4 diff --git a/lib/Carp.pm b/lib/Carp.pm index 0c69860..503da3e 100644 --- a/lib/Carp.pm +++ b/lib/Carp.pm @@ -463,7 +463,7 @@ Example of use: This would make C report the error as coming from a caller not in C, nor from C. -Also read the L section above, about how C decides +Also read the L section above, about how C decides where the error is reported from. Use C<@CARP_NOT>, instead of C<$Carp::CarpLevel>. diff --git a/lib/version/Internals.pod b/lib/version/Internals.pod index 5ff365e..6228da1 100644 --- a/lib/version/Internals.pod +++ b/lib/version/Internals.pod @@ -21,14 +21,14 @@ There are actually two distinct kinds of version objects: =over 4 -=item * Decimal Versions +=item Decimal Versions Any version which "looks like a number", see L. This also includes versions with a single decimal point and a single embedded underscore, see L, even though these must be quoted to preserve the underscore formatting. -=item * Dotted-Decimal Versions +=item Dotted-Decimal Versions Also referred to as "Dotted-Integer", these contains more than one decimal point and may have an optional embedded underscore, see L or C, @@ -472,7 +472,7 @@ down to the same internal representation as well as stringification. =over 4 -=item * Comparison operators +=item Comparison operators Both C and C=E> operators perform the same comparison between terms (upgrading to a version object automatically). Perl automatically @@ -509,7 +509,7 @@ L with multiple decimal points. =over 4 -=item * Logical Operators +=item Logical Operators If you need to test whether a version object has been initialized, you can simply test it directly: diff --git a/os2/OS2/OS2-Process/Process.pm b/os2/OS2/OS2-Process/Process.pm index 7058361..00b11aa 100644 --- a/os2/OS2/OS2-Process/Process.pm +++ b/os2/OS2/OS2-Process/Process.pm @@ -1070,44 +1070,44 @@ returns a list of the following data: =over -=item +=item * Title of the process (in the C list); -=item +=item * window handle of switch entry of the process (in the C list); -=item +=item * window handle of the icon of the process; -=item +=item * process handle of the owner of the entry in C list; -=item +=item * process id of the owner of the entry in C list; -=item +=item * session id of the owner of the entry in C list; -=item +=item * whether visible in C list; -=item +=item * whether item cannot be switched to (note that it is not actually grayed in the C list)); -=item +=item * whether participates in jump sequence; -=item +=item * program type. Possible values are: @@ -1127,7 +1127,7 @@ is a windowed WIN-OS/2 program, it runs in a PROG_WINDOWEDVDM session. Likewise, if it's a full-screen WIN-OS/2 program, it runs in a PROG_VDM session. -=item +=item * switch-entry handle. @@ -1225,7 +1225,7 @@ Some of these API's require sending a message to the specified window. In such a case the process needs to be a PM process, or to be morphed to a PM process via OS2::MorphPM(). -For a temporary morphing to PM use L. +For a temporary morphing to PM use the L class. Keep in mind that PM windows are engaged in 2 "orthogonal" window trees, as well as in the z-order list. @@ -1749,7 +1749,7 @@ specifies whether region scan should be interruptable by signals. Use class C to ensure that clipboard is closed even if the code in the block made a non-local exit. -See L<"OS2::localMorphPM and OS2::localClipbrd classes">. +See the L and L classes. =head2 Control of the PM atom tables @@ -2083,7 +2083,7 @@ For direct access, see also the L<"EXPORTS"> section; the latter way may also provide some performance advantages, since the value of the constant is cached. -=head1 OS2::localMorphPM, OS2::localFlashWindow, and OS2::localClipbrd classes +=head1 L, OS2::localFlashWindow, and OS2::localClipbrd classes The class C morphs the process to PM for the duration of the given scope. @@ -2106,7 +2106,7 @@ morph the application into PM: } C behaves similarly; see -L<"FlashWindow($hwnd,$doFlash)">. +L. =head1 EXAMPLES diff --git a/os2/OS2/OS2-REXX/DLL/DLL.pm b/os2/OS2/OS2-REXX/DLL/DLL.pm index 2a2486e..92eca22 100644 --- a/os2/OS2/OS2-REXX/DLL/DLL.pm +++ b/os2/OS2/OS2-REXX/DLL/DLL.pm @@ -152,7 +152,7 @@ See documentation of L module if you need the variable pool. =head1 DESCRIPTION -=head2 Create a DLL handle +=head2 L $dll = OS2::DLL->module( NAME [, WHERE] ); @@ -166,7 +166,7 @@ The DLL is not unloaded when the return value is destroyed. $dll = OS2::DLL->new( NAME [, WHERE] ); -Same as L|Create a DLL handle>, but in addition to WHERE, looks +Same as C|L, but in addition to WHERE, looks in environment paths PERL5REXX, PERLREXX, PATH (provided for backward compatibility). @@ -174,7 +174,7 @@ compatibility). $dll = load OS2::DLL NAME [, WHERE]; -Same as L|Create a DLL handle (looking in some strange locations)>, +Same as C|L, but returns DLL object reference, or undef on failure (in this case one can get the reason via C) (provided for backward compatibility). diff --git a/pod/perl5111delta.pod b/pod/perl5111delta.pod index 83dc4d6..5ac27ac 100644 --- a/pod/perl5111delta.pod +++ b/pod/perl5111delta.pod @@ -11,6 +11,7 @@ the 5.11.1 release. =head1 Notice +XXX Notice =head1 Incompatible Changes @@ -227,7 +228,8 @@ XXX Any changes specific to a particular platform. VMS and Win32 are the usual stars here. It's probably best to group changes under the same section layout as the main perldelta -=item Obituary + +=head1 Obituary XXX If any significant core contributor has died, we've added a short obituary here. diff --git a/pod/perlmodlib.PL b/pod/perlmodlib.PL index effe9a3..23251ac 100644 --- a/pod/perlmodlib.PL +++ b/pod/perlmodlib.PL @@ -1409,8 +1409,6 @@ old behavior if people rely on it. Document incompatible changes. =back -=back - =head2 Guidelines for Converting Perl 4 Library Scripts into Modules =over 4 @@ -1509,6 +1507,8 @@ or =back +=back + =head1 NOTE Perl does not enforce private and public parts of its modules as you may diff --git a/pod/perlre.pod b/pod/perlre.pod index 1336c5c..10ea30e 100644 --- a/pod/perlre.pod +++ b/pod/perlre.pod @@ -371,6 +371,8 @@ whole character class. For example: matches zero, one, any alphabetic character, and the percent sign. +=over 4 + =item C<$> Currency symbol @@ -383,7 +385,6 @@ Mathematical symbols Modifier symbols (accents) -=back =back