Add perlnetware to docs; regen toc; supply skeleton
Jarkko Hietaniemi [Sat, 16 Jun 2001 22:24:47 +0000 (22:24 +0000)]
docs for some Memoize submodules.

p4raw-id: //depot/perl@10647

12 files changed:
lib/Memoize/AnyDBM_File.pm
lib/Memoize/ExpireFile.pm
lib/Memoize/ExpireTest.pm
lib/Memoize/NDBM_File.pm
lib/Memoize/SDBM_File.pm
lib/Memoize/Storable.pm
pod/buildtoc.PL
pod/perl.pod
pod/perlport.pod
pod/perltoc.pod
win32/Makefile
win32/makefile.mk

index eb2e659..d634f40 100644 (file)
@@ -1,5 +1,15 @@
 package Memoize::AnyDBM_File;
 
+=head1 NAME
+
+Memoize::AnyDBM_File - glue to provide EXISTS for AnyDBM_File for Storable use
+
+=head1 DESCRIPTION
+
+See L<Memoize>.
+
+=cut
+
 use vars qw(@ISA);
 @ISA = qw(DB_File GDBM_File Memoize::NDBM_File Memoize::SDBM_File ODBM_File) unless @ISA;
 
index 958b807..22e4d67 100644 (file)
@@ -1,5 +1,15 @@
-
 package Memoize::ExpireFile;
+
+=head1 NAME
+
+Memoize::ExpireFile - test for Memoize expiration semantics
+
+=head1 DESCRIPTION
+
+See L<Memoize::Expire>.
+
+=cut
+
 use Carp;
 
 sub TIEHASH {
index 1c889ed..41a3ad9 100644 (file)
@@ -1,16 +1,22 @@
+package Memoize::ExpireTest;
 
-# This is just for testing expiration semantics.
-# It's not actually a very good example of how to write
-# an expiration module.  
-#
-# If you are looking for an example, I recommend that you look at the
-# simple example in the Memoize::Expire documentation, or at the
-# code for Memoize::Expire itself.
-#
-# If you have questions, I will be happy to answer them if you
-# send them to mjd-perl/memoize+@plover.com.
+=head1 NAME
 
-package Memoize::ExpireTest;
+Memoize::ExpireTest - test for Memoize expiration semantics
+
+=head1 DESCRIPTION
+
+This is just for testing expiration semantics.  It's not actually a
+very good example of how to write an expiration module.
+
+If you are looking for an example, I recommend that you look at the
+simple example in the Memoize::Expire documentation, or at the code
+for Memoize::Expire itself.
+
+If you have questions, I will be happy to answer them if you send them
+to mjd-perl/memoize+@plover.com.
+
+=cut
 
 my %cache;
 
index ee58cc4..6c36d88 100644 (file)
@@ -1,4 +1,15 @@
 package Memoize::NDBM_File;
+
+=head1 NAME
+
+Memoize::NDBM_File - glue to provide EXISTS for NDBM_File for Storable use
+
+=head1 DESCRIPTION
+
+See L<Memoize>.
+
+=cut
+
 use NDBM_File;
 @ISA = qw(NDBM_File);
 
index 46e550f..d11f69a 100644 (file)
@@ -1,4 +1,15 @@
 package Memoize::SDBM_File;
+
+=head1 NAME
+
+Memoize::SDBM_File - glue to provide EXISTS for SDBM_File for Storable use
+
+=head1 DESCRIPTION
+
+See L<Memoize>.
+
+=cut
+
 use SDBM_File;
 @ISA = qw(SDBM_File);
 
index ff712ae..71e9433 100644 (file)
@@ -1,5 +1,15 @@
-
 package Memoize::Storable;
+
+=head1 NAME
+
+Memoize::Storable - store Memoized data in Storable database
+
+=head1 DESCRIPTION
+
+See L<Memoize>.
+
+=cut
+
 use Storable ();
 $Verbose = 0;
 
index 215dcfe..7b54ed3 100644 (file)
@@ -75,6 +75,7 @@ if (-d "pod") {
     perlmacos
     perlmint
     perlmpeix
+    perlnetware             
     perlos2             
     perlos390           
     perlqnx
index eb2d60d..6138274 100644 (file)
@@ -124,6 +124,7 @@ For ease of access, the Perl manual has been split up into several sections:
     perlmacos          Perl notes for Mac OS (Classic)
     perlmint           Perl notes for MiNT
     perlmpeix          Perl notes for MPE/iX
+    perlnetware                Perl notes for NetWare
     perlos2            Perl notes for OS/2
     perlos390          Perl notes for OS/390
     perlplan9          Perl notes for Plan 9
index 421a186..4ef710d 100644 (file)
@@ -2046,9 +2046,9 @@ http://www.perl.com/CPAN/ports/index.html for binary distributions.
 L<perlaix>, L<perlapollo>, L<perlamiga>, L<perlbeos>, L<perlbs200>,
 L<perlcygwin>, L<perldgux>, L<perldos>, L<perlepoc>, L<perlebcdic>,
 L<perlhurd>, L<perlhpux>, L<perlmachten>, L<perlmacos>, L<perlmint>,
-L<perlmpeix>, L<perlos2>, L<perlos390>, L<perlplan9>, L<perlqnx>,
-L<perlsolaris>, L<perltru64>, L<perlunicode>, L<perlvmesa>,
-L<perlvms>, L<perlvos>, L<perlwin32>, and L<Win32>.
+L<perlmpeix>, L<perlnetware>, L<perlos2>, L<perlos390>, L<perlplan9>,
+L<perlqnx>, L<perlsolaris>, L<perltru64>, L<perlunicode>,
+L<perlvmesa>, L<perlvms>, L<perlvos>, L<perlwin32>, and L<Win32>.
 
 =head1 AUTHORS / CONTRIBUTORS
 
index ba9a0fe..0ad76f2 100644 (file)
@@ -6091,6 +6091,40 @@ public_html/feedback.cgi, src/perl-5.6.0-mpe
 
 =item AUTHOR
 
+=item Name
+
+=item Description
+
+=item Build
+
+=over 4
+
+=item Tools & SDK
+
+=item Setup
+
+Buildtype.bat, SetNWBld.bat, MPKBuild.bat
+
+=item Make
+
+=item Interpreter
+
+=item Extensions
+
+=back
+
+=item Install
+
+=item Build new extensions
+
+=item Known Issues
+
+=item Acknowledgements
+
+=item Author
+
+=item Date
+
 =back
 
 =head2 perlos2 - Perl under OS/2, DOS, Win0.3*, Win0.95 and WinNT.
@@ -6775,6 +6809,18 @@ FETCH_I<type>_ATTRIBUTES, MODIFY_I<type>_ATTRIBUTES
 
 =back
 
+=head2 attrs - set/get attributes of a subroutine (deprecated)
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+method, locked
+
+=back
+
 =head2 autouse - postpone load of modules until a function is used
 
 =over 4
@@ -9390,6 +9436,22 @@ arrays
 
 =back
 
+=head2 Errno - System errno constants
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+=item CAVEATS
+
+=item AUTHOR
+
+=item COPYRIGHT
+
+=back
+
 =head2 Exporter - Implements default import method for modules
 
 =over 4
@@ -9479,7 +9541,7 @@ test_f file
 
 =item USAGE
 
-IV, UV, NV, PV, PVN, YES, NO, UNDEF
+IV, UV, NV, PV, PVN, PVN, YES, NO, UNDEF
 
 =item FUNCTIONS
 
@@ -9491,9 +9553,9 @@ constant_types
 
 memEQ_clause NAME, CHECKED_AT, INDENT
 
-assign INDENT, TYPE, VALUE..
+assign INDENT, TYPE, PRE, POST, VALUE..
 
-return_clause VALUE, TYPE, INDENT, MACRO, DEFAULT
+return_clause VALUE, TYPE, INDENT, MACRO, DEFAULT, PRE, POST, PRE, POST
 
 switch_clause INDENT, NAMELEN, ITEMHASH, ITEM..
 
@@ -9501,12 +9563,16 @@ params WHAT
 
 dump_names
 
-C_constant, name, type, value, macro, default
+C_constant, name, type, value, macro, default, pre, post, def_pre =item
+def_post
 
 XS_constant PACKAGE, TYPES, SUBNAME, C_SUBNAME
 
 autoload PACKAGE, VERSION, AUTOLOADER
 
+WriteConstants ATTRIBUTE =E<gt> VALUE [, ...], NAME, DEFAULT_TYPE,
+BREAKOUT_AT, NAMES, C_FILE, XS_FILE, SUBNAME, C_SUBNAME
+
 =over 4
 
 =item AUTHOR
@@ -9614,6 +9680,53 @@ canonpath, cflags, manifypods, perl_archive
 
 =back
 
+=head2 ExtUtils::MM_NW5 - methods to override UN*X behaviour in
+ExtUtils::MakeMaker
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+=back
+
+catfile
+
+constants (o)
+
+static_lib (o)
+
+dynamic_bs (o)
+
+dynamic_lib (o)
+
+canonpath
+
+perl_script
+
+pm_to_blib
+
+test_via_harness (o)
+
+tool_autosplit (override)
+
+tools_other (o)
+
+xs_o (o)
+
+top_targets (o)
+
+htmlifypods (o)
+
+manifypods (o)
+
+dist_ci (o)
+
+dist_core (o)
+
+pasthru (o)
+
 =head2 ExtUtils::MM_OS2 - methods to override UN*X behaviour in
 ExtUtils::MakeMaker
 
@@ -10300,6 +10413,8 @@ C<untaint_pattern>, C<untaint_skip>
 
 =item NOTES
 
+=item HISTORY
+
 =back
 
 =head2 File::Glob - Perl extension for BSD glob routine
@@ -12156,7 +12271,7 @@ encode_qp($str), decode_qp($str);
 
 =back
 
-=head2 Math::BigFloat - Arbitrary length float math package
+=head2 Math::BigFloat - Arbitrary size floating point math package
 
 =over 4
 
@@ -12164,12 +12279,61 @@ encode_qp($str), decode_qp($str);
 
 =item DESCRIPTION
 
-number format, Error returns 'NaN', Division is computed to, Rounding is
-performed
+=over 4
+
+=item Canonical notation
+
+=item Output
+
+=item C<mantissa()>, C<exponent()> and C<parts()>
+
+=item Accuracy vs. Precision
+
+=item Rounding
+
+ffround ( +$scale ) rounds to the $scale'th place left from the '.',
+counting from the dot. The first digit is numbered 1, ffround ( -$scale )
+rounds to the $scale'th place right from the '.', counting from the dot,
+ffround ( 0 ) rounds to an integer, fround  ( +$scale ) preserves accuracy
+to $scale digits from the left (aka significant digits) and paddes the rest
+with zeros. If the number is between 1 and -1, the significant digits count
+from the first non-zero after the '.', fround  ( -$scale ) and fround ( 0 )
+are a no-ops
+
+=back
+
+=item EXAMPLES
+
+  use Math::BigFloat qw(bstr bint);
+  # not ready yet
+  $x = bstr("1234")                   # string "1234"
+  $x = "$x";                          # same as bstr()
+  $x = bneg("1234")                   # BigFloat "-1234"
+  $x = Math::BigFloat->bneg("1234");   # BigFloat "1234"
+  $x = Math::BigFloat->babs("-12345"); # BigFloat "12345"
+  $x = Math::BigFloat->bnorm("-0 00"); # BigFloat "0"
+  $x = bint(1) + bint(2);             # BigFloat "3"
+  $x = bint(1) + "2";                 # ditto (auto-BigFloatify of "2")
+  $x = bint(1);                       # BigFloat "1"
+  $x = $x + 5 / 2;                    # BigFloat "3"
+  $x = $x ** 3;                       # BigFloat "27"
+  $x *= 2;                            # BigFloat "54"
+  $x = new Math::BigFloat;            # BigFloat "0"
+  $x--;                               # BigFloat "-1"
+
+=item Autocreating constants
+
+=item PERFORMANCE
 
 =item BUGS
 
-=item AUTHOR
+=item CAVEAT
+
+stringify, bstr(), bdiv, Modifying and =, bpow
+
+=item LICENSE
+
+=item AUTHORS
 
 =back
 
@@ -12183,13 +12347,38 @@ performed
 
 Canonical notation, Input, Output
 
-=item EXAMPLES
+=over 4
+
+=item Rounding
+
+bfround ( +$scale ) rounds to the $scale'th place left from the '.', bround
+ ( +$scale ) preserves accuracy to $scale sighnificant digits counted from
+the left and paddes the number with zeros, bround  ( -$scale ) preserves
+accuracy to $scale significant digits counted from the right and paddes the
+number with zeros
+
+=item Internals
+
+=item mantissa(), exponent() and parts()
+
+=back
 
 =item Autocreating constants
 
+=item PERFORMANCE
+
 =item BUGS
 
-=item AUTHOR
+:constant and eval()
+
+=item CAVEATS
+
+stringify, bstr(), bsstr() and 'cmp', int(), bdiv, Modifying and =, bpow,
+Overloading -$x, Mixing different object types, bsqrt()
+
+=item LICENSE
+
+=item AUTHORS
 
 =back
 
@@ -12277,6 +12466,147 @@ cylindrical_to_spherical, spherical_to_cartesian, spherical_to_cylindrical
 
 =back
 
+=head2 Memoize - Make your functions faster by trading space for time
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+=item DETAILS
+
+=item OPTIONS
+
+=over 4
+
+=item INSTALL
+
+=item NORMALIZER
+
+=item C<SCALAR_CACHE>, C<LIST_CACHE>
+
+C<MEMORY>, C<HASH>, C<TIE>, C<FAULT>, C<MERGE>
+
+=back
+
+=item OTHER FACILITIES
+
+=over 4
+
+=item C<unmemoize>
+
+=item C<flush_cache>
+
+=back
+
+=item CAVEATS
+
+=item PERSISTENT CACHE SUPPORT
+
+=item EXPIRATION SUPPORT
+
+=item BUGS
+
+=item MAILING LIST
+
+=item AUTHOR
+
+=item THANK YOU
+
+=back
+
+=head2 Memoize::AnyDBM_File - glue to provide EXISTS for AnyDBM_File for
+Storable use
+
+=over 4
+
+=item DESCRIPTION
+
+=back
+
+=head2 Memoize::Expire - Plug-in module for automatic expiration of
+memoized values
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+=item INTERFACE
+
+ TIEHASH,  EXISTS,  STORE
+
+=item ALTERNATIVES
+
+=item CAVEATS
+
+=item AUTHOR
+
+=item SEE ALSO
+
+=back
+
+=head2 Memoize::ExpireFile - test for Memoize expiration semantics
+
+=over 4
+
+=item DESCRIPTION
+
+=back
+
+=head2 Memoize::ExpireTest - test for Memoize expiration semantics
+
+=over 4
+
+=item DESCRIPTION
+
+=back
+
+=head2 Memoize::NDBM_File - glue to provide EXISTS for NDBM_File for
+Storable use
+
+=over 4
+
+=item DESCRIPTION
+
+=back
+
+=head2 Memoize::SDBM_File - glue to provide EXISTS for SDBM_File for
+Storable use
+
+=over 4
+
+=item DESCRIPTION
+
+=back
+
+=head2 Memoize::Saves - Plug-in module to specify which return values
+should be memoized
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+=item CAVEATS
+
+=item AUTHOR
+
+=item SEE ALSO
+
+=back
+
+=head2 Memoize::Storable - store Memoized data in Storable database
+
+=over 4
+
+=item DESCRIPTION
+
+=back
+
 =head2 NDBM_File - Tied access to ndbm files
 
 =over 4
@@ -14078,6 +14408,27 @@ C<Storable::is_retrieving>
 
 =back
 
+=head2 Syslog, Sys::Syslog, openlog, closelog, setlogmask, syslog - Perl
+interface to the UNIX syslog(3) calls
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+openlog $ident, $logopt, $facility, syslog $priority, $format, @args,
+setlogmask $mask_priority, setlogsock $sock_type (added in 5.004_02),
+closelog
+
+=item EXAMPLES
+
+=item SEE ALSO
+
+=item AUTHOR
+
+=back
+
 =head2 Syslog::Syslog, Sys::Syslog, openlog, closelog, setlogmask, syslog -
 Perl interface to the UNIX syslog(3) calls
 
@@ -14710,6 +15061,24 @@ seconds to other date values
 
 =back
 
+=head2 Time::Seconds - a simple API to convert seconds to other date values
+
+=over 4
+
+=item SYNOPSIS
+
+=item DESCRIPTION
+
+=item METHODS
+
+=item AUTHOR
+
+=item LICENSE
+
+=item Bugs
+
+=back
+
 =head2 Time::gmtime - by-name interface to Perl's built-in gmtime()
 function
 
index fc16107..3418338 100644 (file)
@@ -947,6 +947,7 @@ utils: $(PERLEXE) $(X2P)
        copy ..\README.macos    .\perlmacos.pod\r
        copy ..\README.mint     .\perlmint.pod\r
        copy ..\README.mpeix    .\perlmpeix.pod\r
+       copy ..\README.netware  .\perlnetware.pod\r
        copy ..\README.os2      .\perlos2.pod\r
        copy ..\README.os390    .\perlos390.pod\r
        copy ..\README.plan9    .\perlplan9.pod\r
@@ -1017,7 +1018,7 @@ distclean: clean
            perlbs2000.pod perlcygwin.pod perldgux.pod \\r
            perldos.pod perlepoc.pod perlhurd.pod \\r
            perlhpux.pod perlmachten.pod \\r
-           perlmacos.pod perlmpeix.pod perlmint.pod \\r
+           perlmacos.pod perlmint.pod perlmpeix.pod perlnetware.pod \\r
            perlos2.pod perlos390.pod perlplan9.pod perlqnx.pod \\r
            perlsolaris.pod perlvmesa.pod perlvms.pod perlvos.pod \\r
            perlwin32.pod pod2html pod2latex pod2man pod2text pod2usage \\r
index 4e2ff83..3fd644f 100644 (file)
@@ -1102,6 +1102,7 @@ utils: $(PERLEXE) $(X2P)
        copy ..\README.macos    ..\pod\perlmacos.pod\r
        copy ..\README.mint     ..\pod\perlmint.pod\r
        copy ..\README.mpeix    ..\pod\perlmpeix.pod\r
+       copy ..\README.netware  ..\pod\perlnetware.pod\r
        copy ..\README.os2      ..\pod\perlos2.pod\r
        copy ..\README.os390    ..\pod\perlos390.pod\r
        copy ..\README.plan9    ..\pod\perlplan9.pod\r
@@ -1155,7 +1156,8 @@ distclean: clean
            perlbeos.pod perlbs2000.pod perlcygwin.pod perldgux.pod \\r
            perldos.pod perlepoc.pod perlhpux.pod perlhurd.pod \\r
            perlmachten.pod perlmint.pod \\r
-           perlmacos.pod perlmpeix.pod perlos2.pod perlos390.pod \\r
+           perlmacos.pod perlmpeix.pod perlnetware.pod \\r
+           perlos2.pod perlos390.pod \\r
            perlplan9.pod perlqnx.pod \\r
            perlsolaris.pod perlvmesa.pod perlvms.pod perlvos.pod \\r
            perlwin32.pod pod2html pod2latex pod2man pod2text pod2usage \\r