summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJesse Vincent <jesse@bestpractical.com>2009-10-05 23:42:38 -0400
committerJesse Vincent <jesse@bestpractical.com>2009-10-05 23:57:58 -0400
commit345e23944176348809d2be92e05ba6856a5c0ebc (patch)
tree6c18f1f5b63994d65f86ab00bc8f7ced256432c4
parent69f6a9a1e215d426b05a8e22b39666a532bfffc3 (diff)
downloadperl-345e23944176348809d2be92e05ba6856a5c0ebc.tar.gz
A number of pod fixes found by podcheck.t
-rw-r--r--Porting/perldelta_template2
-rw-r--r--dist/ExtUtils-Install/lib/ExtUtils/Install.pm13
-rw-r--r--dist/ExtUtils-Install/lib/ExtUtils/Packlist.pm4
-rw-r--r--ext/B/B/Concise.pm4
-rw-r--r--ext/mro/mro.pm10
-rw-r--r--lib/Carp.pm2
-rw-r--r--lib/version/Internals.pod18
-rw-r--r--os2/OS2/OS2-Process/Process.pm30
-rw-r--r--os2/OS2/OS2-REXX/DLL/DLL.pm6
-rw-r--r--pod/perl5111delta.pod4
-rw-r--r--pod/perlmodlib.PL4
-rw-r--r--pod/perlre.pod3
12 files changed, 60 insertions, 40 deletions
diff --git a/Porting/perldelta_template b/Porting/perldelta_template
index effa536a3c..484cc97b91 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 c886c69bf2..0928228daf 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<install>
# deprecated forms
diff --git a/dist/ExtUtils-Install/lib/ExtUtils/Packlist.pm b/dist/ExtUtils-Install/lib/ExtUtils/Packlist.pm
index 04f267a0a3..9ff67f4913 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 284f797612..e1bf2af840 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<terse>, C<concise>,
C<linenoise>, C<debug>, C<env>, 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 07a472168c..5acf0e5550 100644
--- a/ext/mro/mro.pm
+++ b/ext/mro/mro.pm
@@ -131,7 +131,7 @@ Note that C<UNIVERSAL> (and any members of C<UNIVERSAL>'s MRO) are not
part of the MRO of a class, even though all classes implicitly inherit
methods from C<UNIVERSAL> 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<c3> or C<dfs>).
@@ -328,9 +328,13 @@ works (like C<goto &maybe::next::method>);
=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 0c698604d2..503da3edb7 100644
--- a/lib/Carp.pm
+++ b/lib/Carp.pm
@@ -463,7 +463,7 @@ Example of use:
This would make C<Carp> report the error as coming from a caller not
in C<My::Carping::Package>, nor from C<My::Friendly::Caller>.
-Also read the L</"Description"> section above, about how C<Carp> decides
+Also read the L</DESCRIPTION> section above, about how C<Carp> 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 5ff365e276..6228da17d8 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<Decimal Versions>. This
also includes versions with a single decimal point and a single embedded
underscore, see L<Decimal Alpha Versions>, 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<Dotted-Decimal
@@ -291,7 +291,7 @@ object method.
=over 4
-=item * New Operator
+=item New Operator
Like all OO interfaces, the new() operator is used to initialize
version objects. One way to increment versions when programming is to
@@ -337,7 +337,7 @@ example case, $v2 will be an empty object of the same type as $v1.
=over 4
-=item * qv()
+=item qv()
An alternate way to create a new version object is through the exported
qv() sub. This is not strictly like other q? operators (like qq, qw),
@@ -377,7 +377,7 @@ For the subsequent examples, the following three objects will be used:
=over 4
-=item * Normal Form
+=item Normal Form
For any version object which is initialized with multiple decimal
places (either quoted or if possible v-string), or initialized using
@@ -402,7 +402,7 @@ In other words, the following is guaranteed to always be true:
=over 4
-=item * Numification
+=item Numification
Although all mathematical operations on version objects are forbidden
by default, it is possible to retrieve a number which corresponds
@@ -421,7 +421,7 @@ trailing zeros to preserve the correct version value.
=over 4
-=item * Stringification
+=item Stringification
The default stringification for version objects returns exactly the same
string as was used to create it, whether you used C<new()> or C<qv()>,
@@ -472,7 +472,7 @@ down to the same internal representation as well as stringification.
=over 4
-=item * Comparison operators
+=item Comparison operators
Both C<cmp> and C<E<lt>=E<gt>> operators perform the same comparison between
terms (upgrading to a version object automatically). Perl automatically
@@ -509,7 +509,7 @@ L<Dotted-Decimal Versions> 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 70583617b1..00b11aab64 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<Ctrl-Esc> list);
-=item
+=item *
window handle of switch entry of the process (in the C<Ctrl-Esc> list);
-=item
+=item *
window handle of the icon of the process;
-=item
+=item *
process handle of the owner of the entry in C<Ctrl-Esc> list;
-=item
+=item *
process id of the owner of the entry in C<Ctrl-Esc> list;
-=item
+=item *
session id of the owner of the entry in C<Ctrl-Esc> list;
-=item
+=item *
whether visible in C<Ctrl-Esc> list;
-=item
+=item *
whether item cannot be switched to (note that it is not actually
grayed in the C<Ctrl-Esc> 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<OS2::localMorphPM class>.
+For a temporary morphing to PM use the L<OS2::localMorphPM> 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<OS2::localClipbrd> 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<OS2::localMorphPM> and L<OS2::localClipbrd> 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::localMorphPM>, OS2::localFlashWindow, and OS2::localClipbrd classes
The class C<OS2::localMorphPM> morphs the process to PM for the duration of
the given scope.
@@ -2106,7 +2106,7 @@ morph the application into PM:
}
C<OS2::localFlashWindow> behaves similarly; see
-L<"FlashWindow($hwnd,$doFlash)">.
+L<FlashWindow($hwnd, $doFlash)>.
=head1 EXAMPLES
diff --git a/os2/OS2/OS2-REXX/DLL/DLL.pm b/os2/OS2/OS2-REXX/DLL/DLL.pm
index 2a2486e863..92eca22bda 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<OS2::REXX> module if you need the variable pool.
=head1 DESCRIPTION
-=head2 Create a DLL handle
+=head2 L<Create a DLL handle>
$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<C<module>|Create a DLL handle>, but in addition to WHERE, looks
+Same as C<module>|L<Create a DLL handle>, 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<C<new>|Create a DLL handle (looking in some strange locations)>,
+Same as C<new>|L<Create a DLL handle (looking in some strange locations)>,
but returns DLL object reference, or undef on failure (in this case one can
get the reason via C<DynaLoader::dl_error()>) (provided for backward
compatibility).
diff --git a/pod/perl5111delta.pod b/pod/perl5111delta.pod
index 83dc4d6d60..5ac27ac146 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 effe9a3c5c..23251ac9bb 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 1336c5c24d..10ea30ee36 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