PODs corrections
authorIlya Zakharevich <ilya@math.ohio-state.edu>
Sat, 8 Mar 1997 02:53:04 +0000 (21:53 -0500)
committerChip Salzenberg <chip@atlantic.net>
Thu, 6 Mar 1997 16:01:12 +0000 (04:01 +1200)
Below I fix misfeatures of PODs found by pod2ipf. Just for fun note that it
auto-recognizes hyperlinks to WWW now.

p5p-msgid: 199703080253.VAA24975@monk.mps.ohio-state.edu

20 files changed:
ext/DB_File/DB_File.pm
ext/Socket/Socket.pm
lib/Class/Template.pm
lib/ExtUtils/Embed.pm
lib/ExtUtils/MM_VMS.pm
lib/ExtUtils/Mksymlists.pm
lib/File/Basename.pm
lib/File/stat.pm
lib/Time/gmtime.pm
lib/Time/localtime.pm
lib/Time/tm.pm
lib/User/grent.pm
lib/User/pwent.pm
pod/perlcall.pod
pod/perldebug.pod
pod/perlfunc.pod
pod/perlguts.pod
pod/perllocale.pod
pod/perlop.pod
pod/perlsub.pod

index c8a7e3e..d962b88 100644 (file)
@@ -1144,7 +1144,7 @@ destroyed.
     undef $db ;
     untie %hash ;
 
-See L<The untie gotcha> for more details.
+See L<The untie Gotcha> for more details.
 
 All the functions defined in L<dbopen> are available except for
 close() and dbopen() itself. The B<DB_File> method interface to the
index e04689d..51dce59 100644 (file)
@@ -47,6 +47,8 @@ all of the commonly used pound-defines like AF_INET, SOCK_STREAM, etc.
 
 In addition, some structure manipulation functions are available:
 
+=over
+
 =item inet_aton HOSTNAME
 
 Takes a string giving the name of a host, and translates that
@@ -144,6 +146,8 @@ Takes a sockaddr_un structure (as returned by pack_sockaddr_un())
 and returns the pathname.  Will croak if the structure does not
 have AF_UNIX in the right place.
 
+=back
+
 =cut
 
 use Carp;
index 23a0d5b..38c2e98 100644 (file)
@@ -45,6 +45,8 @@ This module uses perl5 classes to create nested data types.
 
 =head1 EXAMPLES
 
+=over
+
 =item * Example 1
 
        use Class::Template;
@@ -83,6 +85,8 @@ This module uses perl5 classes to create nested data types.
                bless $r;
        }
 
+=back
+
 =head1 NOTES
 
 Use '%' if the member should point to an anonymous hash.  Use '@' if the
index 4d2ed6a..39d797e 100644 (file)
@@ -272,6 +272,8 @@ ccdlflags(), xsi_header(), xsi_protos(), xsi_body()
 
 =head1 FUNCTIONS
 
+=over
+
 =item xsinit()
 
 Generate C/C++ code for the XS initializer function.
@@ -454,6 +456,8 @@ function to B<boot_ModuleName> for each @modules.
 
 B<xsinit()> uses the xsi_* functions to generate most of it's code.
 
+=back
+
 =head1 EXAMPLES
 
 For examples on how to use B<ExtUtils::Embed> for building C/C++ applications
index aca41ea..eb52da0 100644 (file)
@@ -36,6 +36,8 @@ the semantics.
 
 =head2 Methods always loaded
 
+=over
+
 =item eliminate_macros
 
 Expands MM[KS]/Make macros in a text string, using the contents of
@@ -312,6 +314,7 @@ sub ext {
   ExtUtils::Liblist::ext(@_);
 }
 
+=back
 
 =head2 SelfLoaded methods
 
@@ -321,6 +324,8 @@ For overridden methods, documentation is limited to an explanation
 of why this method overrides the MM_Unix method; see the ExtUtils::MM_Unix
 documentation for more details.
 
+=over
+
 =item guess_name (override)
 
 Try to determine name of extension being built.  We begin with the name
@@ -2353,5 +2358,9 @@ sub nicetext {
 
 1;
 
+=back
+
+=cut
+
 __END__
 
index eeed4bf..4c6814c 100644 (file)
@@ -164,6 +164,8 @@ C<Mksymlists>, which is exported by default from C<ExtUtils::Mksymlists>.
 It takes one argument, a list of key-value pairs, in which the following
 keys are recognized:
 
+=over
+
 =item NAME
 
 This gives the name of the extension (I<e.g.> Tk::Canvas) for which
@@ -217,6 +219,8 @@ extension itself (for instance, some linkers add an '_' to the
 name of the extension).  If it is not specified, it is derived
 from the NAME attribute.  It is presently used only by OS2.
 
+=back
+
 When calling C<Mksymlists>, one should always specify the NAME
 attribute.  In most cases, this is all that's necessary.  In
 the case of unusual extensions, however, the other attributes
index dd7cdcf..6abfcd2 100644 (file)
@@ -95,6 +95,8 @@ would yield
     $dir  eq 'Doc_Root:[Help]'
     $type eq '.Rnh'
 
+=over
+
 =item C<basename>
 
 The basename() routine returns the first element of the list produced
@@ -116,6 +118,8 @@ cases.  For example, for the input file specification F<lib/>, fileparse()
 considers the directory name to be F<lib/>, while dirname() considers the
 directory name to be F<.>).
 
+=back
+
 =cut
 
 require 5.002;
index 014af60..82cb3f6 100644 (file)
@@ -50,7 +50,7 @@ __END__
 
 =head1 NAME
 
-File::stat.pm - by-name interface to Perl's built-in stat() functions
+File::stat - by-name interface to Perl's built-in stat() functions
 
 =head1 SYNOPSIS
 
index 35233f5..353ade4 100644 (file)
@@ -35,7 +35,7 @@ __END__
 
 =head1 NAME
 
-Time::gmtime.pm - by-name interface to Perl's built-in gmtime() function
+Time::gmtime - by-name interface to Perl's built-in gmtime() function
 
 =head1 SYNOPSIS
 
index 2e811e6..8f7695b 100644 (file)
@@ -36,7 +36,7 @@ __END__
 
 =head1 NAME
 
-Time::localtime.pm - by-name interface to Perl's built-in localtime() function
+Time::localtime - by-name interface to Perl's built-in localtime() function
 
 =head1 SYNOPSIS
 
index d1df295..7041432 100644 (file)
@@ -11,7 +11,7 @@ __END__
 
 =head1 NAME
 
-Time::tm.pm - internal object used by Time::gmtime and Time::localtime
+Time::tm - internal object used by Time::gmtime and Time::localtime
 
 =head1 SYNOPSIS
 
index 1185958..3c4635b 100644 (file)
@@ -37,7 +37,7 @@ __END__
 
 =head1 NAME
 
-User::grent.pm - by-name interface to Perl's built-in getgr*() functions
+User::grent - by-name interface to Perl's built-in getgr*() functions
 
 =head1 SYNOPSIS
 
index 9f41fe9..a027fe6 100644 (file)
@@ -49,7 +49,7 @@ __END__
 
 =head1 NAME
 
-User::pwent.pm - by-name interface to Perl's built-in getpw*() functions
+User::pwent - by-name interface to Perl's built-in getpw*() functions
 
 =head1 SYNOPSIS
 
index dc96500..9a4a886 100644 (file)
@@ -565,7 +565,7 @@ Next, we come to XPUSHs. This is where the parameters actually get
 pushed onto the stack. In this case we are pushing a string and an
 integer.
 
-See the L<perlguts/"XSUBs and the Argument Stack"> for details
+See the L<perlguts/"XSUB's and the Argument Stack"> for details
 on how the XPUSH macros work.
 
 =item 6.
index 0c61b74..a682de1 100644 (file)
@@ -465,8 +465,6 @@ corresponds to F</dev/ttyc>, say, by issuing a command like
 
 See L<"Debugger Internals"> below for more details.
 
-=over 12
-
 =item E<lt> [ command ]
 
 Set an action (Perl command) to happen before every debugger prompt.
index 09b5ad3..eb7276a 100644 (file)
@@ -1517,7 +1517,7 @@ Note that, because $_ is a reference into the list value, it can be used
 to modify the elements of the array.  While this is useful and
 supported, it can cause bizarre results if the LIST is not a named
 array.  Similarly, grep returns aliases into the original list,
-much like the way that L<foreach>'s index variable aliases the list
+much like the way that L<Foreach Loops>'s index variable aliases the list
 elements.  That is, modifying an element of a list returned by grep
 actually modifies the element in the original list.
 
index 21e4b2c..8c78802 100644 (file)
@@ -162,7 +162,7 @@ bus error, or just weird results.  Change the zero to C<&sv_undef> in the first
 line and all will be well.
 
 To free an SV that you've created, call C<SvREFCNT_dec(SV*)>.  Normally this
-call is not necessary (see the section on L<Mortality>).
+call is not necessary (see the section on L<Reference Counts and Mortality>).
 
 =head2 What's Really Stored in an SV?
 
@@ -422,8 +422,8 @@ A reference can be blessed into a package with the following function:
     SV* sv_bless(SV* sv, HV* stash);
 
 The C<sv> argument must be a reference.  The C<stash> argument specifies
-which class the reference will belong to.  See the section on L<Stashes>
-for information on converting class names into stashes.
+which class the reference will belong to.  See the section on 
+L<Stashes and Globs> for information on converting class names into stashes.
 
 /* Still under construction */
 
@@ -995,7 +995,7 @@ The correspondence between OP's and I<target>s is not 1-to-1. Different
 OP's in the compile tree of the unit can use the same target, if this
 would not conflict with the expected life of the temporary.
 
-=head2 Scratchpads and recursions
+=head2 Scratchpads and recursion
 
 In fact it is not 100% true that a compiled unit contains a pointer to
 the scratchpad AV. In fact it contains a pointer to an AV of
index 9ac77b8..d393b81 100644 (file)
@@ -63,7 +63,7 @@ C<define>.
 
 If you want a Perl application to process and present your data
 according to a particular locale, the application code should include
-the S<C<use locale>> pragma (see L<The use locale Pragma>) where
+the S<C<use locale>> pragma (see L<The use locale pragma>) where
 appropriate, and B<at least one> of the following must be true:
 
 =over 4
@@ -345,7 +345,7 @@ call strxfrm() for both their operands, then do a byte-by-byte
 comparison of the transformed strings.  By calling strxfrm() explicitly,
 and using a non locale-affected comparison, the example attempts to save
 a couple of transformations.  In fact, it doesn't save anything: Perl
-magic (see L<perlguts/Magic>) creates the transformed version of a
+magic (see L<perlguts/Magic Variables>) creates the transformed version of a
 string the first time it's needed in a comparison, then keeps it around
 in case it's needed again.  An example rewritten the easy way with
 C<cmp> runs just about as fast.  It also copes with null characters
@@ -703,7 +703,7 @@ L<The setlocale function>) was always in force, even if the program
 environment suggested otherwise.  By default, Perl still behaves this
 way so as to maintain backward compatibility.  If you want a Perl
 application to pay attention to locale information, you B<must> use
-the S<C<use locale>> pragma (see L<The S<C<use locale>> Pragma>) to
+the S<C<use locale>> pragma (see L<The use locale Pragma>) to
 instruct it to do so.
 
 Versions of Perl from 5.002 to 5.003 did use the C<LC_CTYPE>
index 88a8af0..71794fa 100644 (file)
@@ -88,7 +88,7 @@ Also parsed as terms are the C<do {}> and C<eval {}> constructs, as
 well as subroutine and method calls, and the anonymous 
 constructors C<[]> and C<{}>.
 
-See also L<Quote and Quote-Like Operators> toward the end of this section,
+See also L<Quote and Quote-like Operators> toward the end of this section,
 as well as L<"I/O Operators">.
 
 =head2 The Arrow Operator
index a38d05b..62b5f0e 100644 (file)
@@ -503,7 +503,7 @@ Even if you don't want to modify an array, this mechanism is useful for
 passing multiple arrays in a single LIST, because normally the LIST
 mechanism will merge all the array values so that you can't extract out
 the individual arrays.  For more on typeglobs, see
-L<perldata/"Typeglobs and FileHandles">.
+L<perldata/"Typeglobs and Filehandles">.
 
 =head2 Pass by Reference