Regen doc, regen toc.
authorJarkko Hietaniemi <jhi@iki.fi>
Tue, 19 Feb 2002 15:20:52 +0000 (15:20 +0000)
committerJarkko Hietaniemi <jhi@iki.fi>
Tue, 19 Feb 2002 15:20:52 +0000 (15:20 +0000)
p4raw-id: //depot/perl@14775

pod/buildtoc.PL
pod/perlapi.pod
pod/perltoc.pod

index 47972b7..b38bec5 100644 (file)
@@ -286,8 +286,6 @@ find \&getpods => qw(../lib ../ext);
 
 sub getpods {
     if (/\.p(od|m)$/) {
-       # Skip .pm files that have corresponding .pod files, and Functions.pm.
-       return if /(.*)\.pm$/ && -f "$1.pod";
        my $file = $File::Find::name;
        return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
         return if $file =~ m!lib/Attribute/Handlers/demo/!;
index dc52664..af5bf36 100644 (file)
@@ -2544,22 +2544,22 @@ version which guarantees to evaluate sv only once.
 =for hackers
 Found in file sv.h
 
-=item SvIVx
+=item SvIVX
 
-Coerces the given SV to an integer and returns it. Guarantees to evaluate
-sv only once. Use the more efficient C<SvIV> otherwise.
+Returns the raw value in the SV's IV slot, without checks or conversions.
+Only use when you are sure SvIOK is true. See also C<SvIV()>.
 
-       IV      SvIVx(SV* sv)
+       IV      SvIVX(SV* sv)
 
 =for hackers
 Found in file sv.h
 
-=item SvIVX
+=item SvIVx
 
-Returns the raw value in the SV's IV slot, without checks or conversions.
-Only use when you are sure SvIOK is true. See also C<SvIV()>.
+Coerces the given SV to an integer and returns it. Guarantees to evaluate
+sv only once. Use the more efficient C<SvIV> otherwise.
 
-       IV      SvIVX(SV* sv)
+       IV      SvIVx(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -2659,22 +2659,22 @@ which guarantees to evaluate sv only once.
 =for hackers
 Found in file sv.h
 
-=item SvNVX
+=item SvNVx
 
-Returns the raw value in the SV's NV slot, without checks or conversions.
-Only use when you are sure SvNOK is true. See also C<SvNV()>.
+Coerces the given SV to a double and returns it. Guarantees to evaluate
+sv only once. Use the more efficient C<SvNV> otherwise.
 
-       NV      SvNVX(SV* sv)
+       NV      SvNVx(SV* sv)
 
 =for hackers
 Found in file sv.h
 
-=item SvNVx
+=item SvNVX
 
-Coerces the given SV to a double and returns it. Guarantees to evaluate
-sv only once. Use the more efficient C<SvNV> otherwise.
+Returns the raw value in the SV's NV slot, without checks or conversions.
+Only use when you are sure SvNOK is true. See also C<SvNV()>.
 
-       NV      SvNVx(SV* sv)
+       NV      SvNVX(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -2760,8 +2760,9 @@ Found in file sv.h
 
 =item SvPV
 
-Returns a pointer to the string in the SV, or a stringified form of the SV
-if the SV does not contain a string.  Handles 'get' magic. See also
+Returns a pointer to the string in the SV, or a stringified form of
+the SV if the SV does not contain a string.  The SV may cache the
+stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
 C<SvPVx> for a version which guarantees to evaluate sv only once.
 
        char*   SvPV(SV* sv, STRLEN len)
@@ -2868,29 +2869,30 @@ Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
 =for hackers
 Found in file sv.h
 
-=item SvPVx
+=item SvPVX
 
-A version of C<SvPV> which guarantees to evaluate sv only once.
+Returns a pointer to the physical string in the SV.  The SV must contain a
+string.
 
-       char*   SvPVx(SV* sv, STRLEN len)
+       char*   SvPVX(SV* sv)
 
 =for hackers
 Found in file sv.h
 
-=item SvPVX
+=item SvPVx
 
-Returns a pointer to the physical string in the SV.  The SV must contain a
-string.
+A version of C<SvPV> which guarantees to evaluate sv only once.
 
-       char*   SvPVX(SV* sv)
+       char*   SvPVx(SV* sv, STRLEN len)
 
 =for hackers
 Found in file sv.h
 
 =item SvPV_force
 
-Like <SvPV> but will force the SV into becoming a string (SvPOK).  You want
-force if you are going to update the SvPVX directly.
+Like C<SvPV> but will force the SV into containing just a string
+(C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
+directly.
 
        char*   SvPV_force(SV* sv, STRLEN len)
 
@@ -2899,8 +2901,9 @@ Found in file sv.h
 
 =item SvPV_force_nomg
 
-Like <SvPV> but will force the SV into becoming a string (SvPOK).  You want
-force if you are going to update the SvPVX directly. Doesn't process magic.
+Like C<SvPV> but will force the SV into containing just a string
+(C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
+directly. Doesn't process magic.
 
        char*   SvPV_force_nomg(SV* sv, STRLEN len)
 
@@ -2909,8 +2912,9 @@ Found in file sv.h
 
 =item SvPV_nolen
 
-Returns a pointer to the string in the SV, or a stringified form of the SV
-if the SV does not contain a string.  Handles 'get' magic.
+Returns a pointer to the string in the SV, or a stringified form of
+the SV if the SV does not contain a string.  The SV may cache the
+stringified form becoming C<SvPOK>.  Handles 'get' magic.
 
        char*   SvPV_nolen(SV* sv)
 
@@ -4554,16 +4558,18 @@ The "ustrp" is a pointer to the character buffer to put the
 conversion result to.  The "lenp" is a pointer to the length
 of the result.
 
-The "swash" is a pointer to the swash to use.
+The "swashp" is a pointer to the swash to use.
 
-The "normal" is a string like "ToLower" which means the swash
-$utf8::ToLower, which is stored in lib/unicore/To/Lower.pl,
-and loaded by SWASHGET, using lib/utf8_heavy.pl.
+Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
+and loaded by SWASHGET, using lib/utf8_heavy.pl.  The special (usually,
+but not always, a multicharacter mapping), is tried first.
+
+The "special" is a string like "utf8::ToSpecLower", which means the
+hash %utf8::ToSpecLower.  The access to the hash is through
+Perl_to_utf8_case().
 
-The "special" is a string like "utf8::ToSpecLower", which means
-the hash %utf8::ToSpecLower, which is stored in the same file,
-lib/unicore/To/Lower.pl, and also loaded by SWASHGET.  The access
-to the hash is by Perl_to_utf8_case().
+The "normal" is a string like "ToLower" which means the swash
+%utf8::ToLower.
 
        UV      to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
 
index 95a0fee..806e12f 100644 (file)
@@ -944,10 +944,10 @@ B<-w>, B<-W>, B<-X>
 
 =item Debugger Commands
 
-h [command], p expr, x expr, V [pkg [vars]], X [vars], T, s [expr], n
-[expr], r, <CR>, c [line|sub], l, l min+incr, l min-max, l line, l subname,
--, w [line], f filename, /pattern/, ?pattern?, L, S [[!]regex], t, t expr,
-b [line] [condition], b subname [condition], b postpone subname
+h [command], p expr, x [maxdepth] expr, V [pkg [vars]], X [vars], T, s
+[expr], n [expr], r, <CR>, c [line|sub], l, l min+incr, l min-max, l line,
+l subname, -, w [line], f filename, /pattern/, ?pattern?, L, S [[!]regex],
+t, t expr, b [line] [condition], b subname [condition], b postpone subname
 [condition], b load filename, b compile subname, d [line], D, a [line]
 command, a [line], A, W expr, W, O booloption .., O anyoption? .., O
 option=value .., < ?, < [ command ], << command, > ?, > command, >>
@@ -960,9 +960,10 @@ cmd, @ file, H -number, q or ^D, R, |dbcmd, ||dbcmd, command, m expr, man
 C<recallCommand>, C<ShellBang>, C<pager>, C<tkRunning>, C<signalLevel>,
 C<warnLevel>, C<dieLevel>, C<AutoTrace>, C<LineInfo>, C<inhibit_exit>,
 C<PrintRet>, C<ornaments>, C<frame>, C<maxTraceLen>, C<windowSize>,
-C<arrayDepth>, C<hashDepth>, C<compactDump>, C<veryCompact>, C<globPrint>,
-C<DumpDBFiles>, C<DumpPackages>, C<DumpReused>, C<quote>, C<HighBit>,
-C<undefPrint>, C<UsageOnly>, C<TTY>, C<noTTY>, C<ReadLine>, C<NonStop>
+C<arrayDepth>, C<hashDepth>, C<dumpDepth>, C<compactDump>, C<veryCompact>,
+C<globPrint>, C<DumpDBFiles>, C<DumpPackages>, C<DumpReused>, C<quote>,
+C<HighBit>, C<undefPrint>, C<UsageOnly>, C<TTY>, C<noTTY>, C<ReadLine>,
+C<NonStop>
 
 =item Debugger input/output
 
@@ -2817,8 +2818,8 @@ References, Tutorials, Task-Oriented, Special Topics
 
 =back
 
-=head2 perlfaq3 - Programming Tools ($Revision: 1.13 $, $Date: 2002/02/08
-22:32:47 $)
+=head2 perlfaq3 - Programming Tools ($Revision: 1.15 $, $Date: 2002/02/11
+19:29:52 $)
 
 =over 4
 
@@ -3117,8 +3118,8 @@ array of hashes or arrays?
 
 =back
 
-=head2 perlfaq5 - Files and Formats ($Revision: 1.8 $, $Date: 2002/01/28
-04:17:26 $)
+=head2 perlfaq5 - Files and Formats ($Revision: 1.9 $, $Date: 2002/02/11
+19:30:21 $)
 
 =over 4
 
@@ -4372,12 +4373,12 @@ svtype, SVt_IV, SVt_NV, SVt_PV, SVt_PVAV, SVt_PVCV, SVt_PVHV, SVt_PVMG
 get_sv, looks_like_number, newRV_inc, newRV_noinc, newSV, newSViv, newSVnv,
 newSVpv, newSVpvf, newSVpvn, newSVpvn_share, newSVrv, newSVsv, newSVuv,
 new_vstring, SvCUR, SvCUR_set, SvEND, SvGROW, SvIOK, SvIOKp, SvIOK_notUV,
-SvIOK_off, SvIOK_on, SvIOK_only, SvIOK_only_UV, SvIOK_UV, SvIV, SvIVx,
-SvIVX, SvLEN, SvNIOK, SvNIOKp, SvNIOK_off, SvNOK, SvNOKp, SvNOK_off,
-SvNOK_on, SvNOK_only, SvNV, SvNVX, SvNVx, SvOK, SvOOK, SvPOK, SvPOKp,
+SvIOK_off, SvIOK_on, SvIOK_only, SvIOK_only_UV, SvIOK_UV, SvIV, SvIVX,
+SvIVx, SvLEN, SvNIOK, SvNIOKp, SvNIOK_off, SvNOK, SvNOKp, SvNOK_off,
+SvNOK_on, SvNOK_only, SvNV, SvNVx, SvNVX, SvOK, SvOOK, SvPOK, SvPOKp,
 SvPOK_off, SvPOK_on, SvPOK_only, SvPOK_only_UTF8, SvPV, SvPVbyte,
 SvPVbytex, SvPVbytex_force, SvPVbyte_force, SvPVbyte_nolen, SvPVutf8,
-SvPVutf8x, SvPVutf8x_force, SvPVutf8_force, SvPVutf8_nolen, SvPVx, SvPVX,
+SvPVutf8x, SvPVutf8x_force, SvPVutf8_force, SvPVutf8_nolen, SvPVX, SvPVx,
 SvPV_force, SvPV_force_nomg, SvPV_nolen, SvREFCNT, SvREFCNT_dec,
 SvREFCNT_inc, SvROK, SvROK_off, SvROK_on, SvRV, SvSTASH, SvTAINT,
 SvTAINTED, SvTAINTED_off, SvTAINTED_on, SvTRUE, SvTYPE, SvUNLOCK, SvUOK,
@@ -7944,6 +7945,8 @@ LIST, waitpid PID,FLAGS
 
 =over 4
 
+=item Multiple methods to build perl for VOS
+
 =item Stratus POSIX Support
 
 =back
@@ -8332,6 +8335,20 @@ new, phash
 
 =back
 
+=head2 if - C<use> a Perl module if a condition holds
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+=item BUGS
+
+=item AUTHOR
+
+=back
+
 =head2 integer - Perl pragma to use integer arithmetic instead of floating
 point
 
@@ -13599,7 +13616,7 @@ EXPR, tainted EXPR, weaken REF
 
 =item SEE ALSO
 
-Locale::Language, Locale::Country, Locale::Currency
+Locale::Language, Locale::Country, Locale::Script, Locale::Currency
 
 =item AUTHOR
 
@@ -13613,41 +13630,21 @@ Locale::Language, Locale::Country, Locale::Currency
 
 =item SYNOPSIS
 
-=back
-
-=over 4
-
 =item DESCRIPTION
 
 B<alpha-2>, B<alpha-3>, B<numeric>
 
-=back
-
-=over 4
-
 =item CONVERSION ROUTINES
 
 code2country( CODE, [ CODESET ] ), country2code( STRING, [ CODESET ] ),
 country_code2code( CODE, CODESET, CODESET )
 
-=back
-
-=over 4
-
 =item QUERY ROUTINES
 
 C<all_country_codes( [ CODESET ] )>, C<all_country_names( [ CODESET ] )>
 
-=back
-
-=over 4
-
 =item CODE ALIASING
 
-=back
-
-=over 4
-
 =item EXAMPLES
 
 =item DOMAIN NAMES
@@ -13656,7 +13653,7 @@ C<all_country_codes( [ CODESET ] )>, C<all_country_names( [ CODESET ] )>
 
 =item SEE ALSO
 
-Locale::Language, Locale::Currency, ISO 3166,
+Locale::Language, Locale::Script, Locale::Currency, ISO 3166,
 http://www.din.de/gremien/nas/nabd/iso3166ma/,
 http://www.egt.ie/standards/iso3166/iso3166-1-en.html,
 http://www.cia.gov/cia/publications/factbook/docs/app-f.html
@@ -13674,41 +13671,26 @@ identification (ISO 4217)
 
 =item SYNOPSIS
 
-=back
-
-=over 4
-
 =item DESCRIPTION
 
 XTS, XXX
 
-=back
-
-=over 4
-
 =item CONVERSION ROUTINES
 
 code2currency(), currency2code()
 
-=back
-
-=over 4
-
 =item QUERY ROUTINES
 
 C<all_currency_codes()>, C<all_currency_names()>
 
-=back
-
-=over 4
-
 =item EXAMPLES
 
 =item KNOWN BUGS AND LIMITATIONS
 
 =item SEE ALSO
 
-Locale::Country, ISO 4217:1995, http://www.bsi-global.com/iso4217currency
+Locale::Country, Locale::Script, ISO 4217:1995,
+http://www.bsi-global.com/iso4217currency
 
 =item AUTHOR
 
@@ -13723,39 +13705,23 @@ Locale::Country, ISO 4217:1995, http://www.bsi-global.com/iso4217currency
 
 =item SYNOPSIS
 
-=back
-
-=over 4
-
 =item DESCRIPTION
 
-=back
-
-=over 4
-
 =item CONVERSION ROUTINES
 
 code2language(), language2code()
 
-=back
-
-=over 4
-
 =item QUERY ROUTINES
 
 C<all_language_codes()>, C<all_language_names()>
 
-=back
-
-=over 4
-
 =item EXAMPLES
 
 =item KNOWN BUGS AND LIMITATIONS
 
 =item SEE ALSO
 
-Locale::Country, Locale::Currency, ISO 639:1988 (E/F),
+Locale::Country, Locale::Script, Locale::Currency, ISO 639:1988 (E/F),
 http://lcweb.loc.gov/standards/iso639-2/langhome.html
 
 =item AUTHOR
@@ -13853,6 +13819,46 @@ $language->language_tag(), $language->encoding()
 
 =back
 
+=head2 Locale::Script - ISO codes for script identification (ISO 15924)
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+B<alpha-2>, B<alpha-3>, B<numeric>
+
+=over 4
+
+=item SPECIAL CODES
+
+=back
+
+=item CONVERSION ROUTINES
+
+code2script( CODE, [ CODESET ] ), script2code( STRING, [ CODESET ] ),
+script_code2code( CODE, CODESET, CODESET )
+
+=item QUERY ROUTINES
+
+C<all_script_codes ( [ CODESET ] )>, C<all_script_names ( [ CODESET ] )>
+
+=item EXAMPLES
+
+=item KNOWN BUGS AND LIMITATIONS
+
+=item SEE ALSO
+
+Locale::Language, Locale::Currency, Locale::Country, ISO 15924,
+http://www.evertype.com/standards/iso15924/
+
+=item AUTHOR
+
+=item COPYRIGHT
+
+=back
+
 =head2 MIME::Base64 - Encoding and decoding of base64 strings
 
 =over 4
@@ -17472,7 +17478,8 @@ EOF this, TELL this, SEEK this, offset, whence, DESTROY this
 
 =back
 
-=head2 Tie::Hash, Tie::StdHash - base class definitions for tied hashes
+=head2 Tie::Hash, Tie::StdHash, Tie::ExtraHash - base class definitions for
+tied hashes
 
 =over 4
 
@@ -17483,12 +17490,34 @@ EOF this, TELL this, SEEK this, offset, whence, DESTROY this
 TIEHASH classname, LIST, STORE this, key, value, FETCH this, key, FIRSTKEY
 this, NEXTKEY this, lastkey, EXISTS this, key, DELETE this, key, CLEAR this
 
-=item CAVEATS
+=item Inheriting from B<Tie::StdHash>
+
+=item Inheriting from B<Tie::ExtraHash>
+
+=item C<UNTIE> and C<DESTROY>
 
 =item MORE INFORMATION
 
 =back
 
+=head2 Tie::Memoize - add data to hash when needed
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+=item Inheriting from B<Tie::Memoize>
+
+=item EXAMPLE
+
+=item BUGS
+
+=item AUTHOR
+
+=back
+
 =head2 Tie::RefHash - use references as hash keys
 
 =over 4
@@ -17860,9 +17889,10 @@ Win32::IsWinNT(), Win32::IsWin95(), Win32::LoadLibrary(LIBNAME),
 Win32::LoginName(), Win32::LookupAccountName(SYSTEM, ACCOUNT, DOMAIN, SID,
 SIDTYPE), Win32::LookupAccountSID(SYSTEM, SID, ACCOUNT, DOMAIN, SIDTYPE),
 Win32::MsgBox(MESSAGE [, FLAGS [, TITLE]]), Win32::NodeName(),
-Win32::RegisterServer(LIBRARYNAME), Win32::SetCwd(NEWDIRECTORY),
-Win32::SetLastError(ERROR), Win32::Sleep(TIME), Win32::Spawn(COMMAND, ARGS,
-PID), Win32::UnregisterServer(LIBRARYNAME)
+Win32::RegisterServer(LIBRARYNAME), Win32::SetChildShowWindow(SHOWWINDOW),
+Win32::SetCwd(NEWDIRECTORY), Win32::SetLastError(ERROR),
+Win32::Sleep(TIME), Win32::Spawn(COMMAND, ARGS, PID),
+Win32::UnregisterServer(LIBRARYNAME)
 
 =back