diff options
author | Ilya Zakharevich <ilya@math.ohio-state.edu> | 1997-03-07 21:53:04 -0500 |
---|---|---|
committer | Chip Salzenberg <chip@atlantic.net> | 1997-03-07 04:01:12 +1200 |
commit | 72451f4af0d31f24ef5b12bc5d034e3e8b35d43d (patch) | |
tree | cc8fc9d888deac9264ba3e52e524e7edd1461ddc | |
parent | e6834c60cd85866fc530e8b4bb831af6186bad4d (diff) | |
download | perl-72451f4af0d31f24ef5b12bc5d034e3e8b35d43d.tar.gz |
PODs corrections
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
-rw-r--r-- | ext/DB_File/DB_File.pm | 2 | ||||
-rw-r--r-- | ext/Socket/Socket.pm | 4 | ||||
-rw-r--r-- | lib/Class/Template.pm | 4 | ||||
-rw-r--r-- | lib/ExtUtils/Embed.pm | 4 | ||||
-rw-r--r-- | lib/ExtUtils/MM_VMS.pm | 9 | ||||
-rw-r--r-- | lib/ExtUtils/Mksymlists.pm | 4 | ||||
-rw-r--r-- | lib/File/Basename.pm | 4 | ||||
-rw-r--r-- | lib/File/stat.pm | 2 | ||||
-rw-r--r-- | lib/Time/gmtime.pm | 2 | ||||
-rw-r--r-- | lib/Time/localtime.pm | 2 | ||||
-rw-r--r-- | lib/Time/tm.pm | 2 | ||||
-rw-r--r-- | lib/User/grent.pm | 2 | ||||
-rw-r--r-- | lib/User/pwent.pm | 2 | ||||
-rw-r--r-- | pod/perlcall.pod | 2 | ||||
-rw-r--r-- | pod/perldebug.pod | 2 | ||||
-rw-r--r-- | pod/perlfunc.pod | 2 | ||||
-rw-r--r-- | pod/perlguts.pod | 8 | ||||
-rw-r--r-- | pod/perllocale.pod | 6 | ||||
-rw-r--r-- | pod/perlop.pod | 2 | ||||
-rw-r--r-- | pod/perlsub.pod | 2 |
20 files changed, 47 insertions, 20 deletions
diff --git a/ext/DB_File/DB_File.pm b/ext/DB_File/DB_File.pm index c8a7e3eadc..d962b88b2e 100644 --- a/ext/DB_File/DB_File.pm +++ b/ext/DB_File/DB_File.pm @@ -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 diff --git a/ext/Socket/Socket.pm b/ext/Socket/Socket.pm index e04689d9b8..51dce5939e 100644 --- a/ext/Socket/Socket.pm +++ b/ext/Socket/Socket.pm @@ -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; diff --git a/lib/Class/Template.pm b/lib/Class/Template.pm index 23a0d5ba83..38c2e98e66 100644 --- a/lib/Class/Template.pm +++ b/lib/Class/Template.pm @@ -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 diff --git a/lib/ExtUtils/Embed.pm b/lib/ExtUtils/Embed.pm index 4d2ed6a77a..39d797e430 100644 --- a/lib/ExtUtils/Embed.pm +++ b/lib/ExtUtils/Embed.pm @@ -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 diff --git a/lib/ExtUtils/MM_VMS.pm b/lib/ExtUtils/MM_VMS.pm index aca41ea371..eb52da01a5 100644 --- a/lib/ExtUtils/MM_VMS.pm +++ b/lib/ExtUtils/MM_VMS.pm @@ -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__ diff --git a/lib/ExtUtils/Mksymlists.pm b/lib/ExtUtils/Mksymlists.pm index eeed4bf794..4c6814cbcb 100644 --- a/lib/ExtUtils/Mksymlists.pm +++ b/lib/ExtUtils/Mksymlists.pm @@ -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 diff --git a/lib/File/Basename.pm b/lib/File/Basename.pm index dd7cdcf82e..6abfcd2cb4 100644 --- a/lib/File/Basename.pm +++ b/lib/File/Basename.pm @@ -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; diff --git a/lib/File/stat.pm b/lib/File/stat.pm index 014af60c5b..82cb3f6df3 100644 --- a/lib/File/stat.pm +++ b/lib/File/stat.pm @@ -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 diff --git a/lib/Time/gmtime.pm b/lib/Time/gmtime.pm index 35233f586a..353ade49ef 100644 --- a/lib/Time/gmtime.pm +++ b/lib/Time/gmtime.pm @@ -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 diff --git a/lib/Time/localtime.pm b/lib/Time/localtime.pm index 2e811e627f..8f7695b0f5 100644 --- a/lib/Time/localtime.pm +++ b/lib/Time/localtime.pm @@ -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 diff --git a/lib/Time/tm.pm b/lib/Time/tm.pm index d1df295683..7041432c0d 100644 --- a/lib/Time/tm.pm +++ b/lib/Time/tm.pm @@ -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 diff --git a/lib/User/grent.pm b/lib/User/grent.pm index 1185958430..3c4635ba2a 100644 --- a/lib/User/grent.pm +++ b/lib/User/grent.pm @@ -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 diff --git a/lib/User/pwent.pm b/lib/User/pwent.pm index 9f41fe9f39..a027fe627b 100644 --- a/lib/User/pwent.pm +++ b/lib/User/pwent.pm @@ -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 diff --git a/pod/perlcall.pod b/pod/perlcall.pod index dc965009d6..9a4a886a59 100644 --- a/pod/perlcall.pod +++ b/pod/perlcall.pod @@ -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. diff --git a/pod/perldebug.pod b/pod/perldebug.pod index 0c61b74350..a682de1ade 100644 --- a/pod/perldebug.pod +++ b/pod/perldebug.pod @@ -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. diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod index 09b5ad3df7..eb7276a3b4 100644 --- a/pod/perlfunc.pod +++ b/pod/perlfunc.pod @@ -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. diff --git a/pod/perlguts.pod b/pod/perlguts.pod index 21e4b2c789..8c78802fb4 100644 --- a/pod/perlguts.pod +++ b/pod/perlguts.pod @@ -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 diff --git a/pod/perllocale.pod b/pod/perllocale.pod index 9ac77b8e48..d393b81483 100644 --- a/pod/perllocale.pod +++ b/pod/perllocale.pod @@ -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> diff --git a/pod/perlop.pod b/pod/perlop.pod index 88a8af0fd4..71794fa759 100644 --- a/pod/perlop.pod +++ b/pod/perlop.pod @@ -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 diff --git a/pod/perlsub.pod b/pod/perlsub.pod index a38d05be25..62b5f0e6b0 100644 --- a/pod/perlsub.pod +++ b/pod/perlsub.pod @@ -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 |