add stub docs for ext/B, other minor tweaks

p4raw-id: //depot/perl@1518

diff --git a/Changes b/Changes
index 096ba0da34b09671da67f20003c59d5c84b6048f..a50e1aa85197d58d0a3b0e0ed02bda6c1bc8697b 100644 (file)
--- a/Changes
+++ b/Changes
@@ -68,6 +68,17 @@ indicator:
 Version 5.004_75        5.005 Public Beta, Issue 1
 ----------------
 
+____________________________________________________________________________
+[  1517] By: gsar                                  on 1998/07/15  08:27:15
+        Log: up patchlevel to 75 (Beta, Issue 1), add podpatch
+             From: abigail@fnx.com
+             Date: Wed, 15 Jul 1998 04:03:44 -0400 (EDT)
+             Message-ID: <19980715080344.21975.qmail@betelgeuse.wayne.fnx.com>
+             Subject: [PATCH 5.004_74] pod/perlop.pod
+     Branch: perl
+          ! Changes patchlevel.h pod/perlop.pod win32/Makefile
+          ! win32/config_H.bc win32/config_H.gc win32/config_H.vc
+           ! win32/makefile.mk
 ____________________________________________________________________________
 [  1516] By: gsar                                  on 1998/07/15  08:04:24
         Log: From:    abigail@fnx.com

diff --git a/Porting/config_H b/Porting/config_H
index 56de7343009805efc2e324dff393f31ee548de29..b4d96217eff8320c7c25ae8bcaaafe5dc9245d3d 100644 (file)
--- a/Porting/config_H
+++ b/Porting/config_H
@@ -809,7 +809,7 @@
 /* EBCDIC:
  *     This symbol, if defined, indicates that this system uses
  *     EBCDIC encoding.
- *.
+ */
 /*#define      EBCDIC          / **/
 
 /* I_ARPA_INET:

diff --git a/config_h.SH b/config_h.SH
index c9144ca0773add949a152b009f5b9fceecb82dc0..49f86c7de749407e299723261f5a9f540c885516 100644 (file)
--- a/config_h.SH
+++ b/config_h.SH
@@ -823,7 +823,7 @@ sed <<!GROK!THIS! >config.h -e 's!^#undef\(.*/\)\*!/\*#define\1 \*!' -e 's!^#un-
 /* EBCDIC:
  *     This symbol, if defined, indicates that this system uses
  *     EBCDIC encoding.
- *.
+ */
 #$ebcdic       EBCDIC          /**/
 
 /* I_ARPA_INET:

diff --git a/ext/B/B.pm b/ext/B/B.pm
index 5897ef10136236a1772d92c3a2c3a803d456e39f..dcf78090142f952020de54d365ee83d0bf3d3697 100644 (file)
--- a/ext/B/B.pm
+++ b/ext/B/B.pm
@@ -270,3 +270,23 @@ sub walksymtable {
 bootstrap B;
 
 1;
+
+__END__
+
+=head1 NAME
+
+B - The Perl Compiler
+
+=head1 SYNOPSIS
+
+       use B;
+
+=head1 DESCRIPTION
+
+See F<ext/B/README>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/Asmdata.pm b/ext/B/B/Asmdata.pm
index b77f15089fe3e231f3027c3dcd838fc96b77ab16..340876b71b27058a59822fbfa8ba0662dda13fe0 100644 (file)
--- a/ext/B/B/Asmdata.pm
+++ b/ext/B/B/Asmdata.pm
@@ -148,3 +148,23 @@ while (($insn_name, $insn_data) = each %insn_data) {
 @insn_name = map($_ || "unused", @insn_name);
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Asmdata - Autogenerated data about Perl ops, used to generate bytecode
+
+=head1 SYNOPSIS
+
+       use Asmdata;
+
+=head1 DESCRIPTION
+
+See F<ext/B/B/Asmdata.pm>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/Assembler.pm b/ext/B/B/Assembler.pm
index 0729b90f286a3b6d3cdf8aa0070e89f7b096f8b7..defcbdf958d25aed68117a4fa0255e0680b8838a 100644 (file)
--- a/ext/B/B/Assembler.pm
+++ b/ext/B/B/Assembler.pm
@@ -205,3 +205,23 @@ sub assemble_fh {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Assembler - Assemble Perl bytecode
+
+=head1 SYNOPSIS
+
+       use Assembler;
+
+=head1 DESCRIPTION
+
+See F<ext/B/B/Assembler.pm>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/Bblock.pm b/ext/B/B/Bblock.pm
index 125c8a3c650022c2977fa941096b66ad949ee18f..a54431b4ce71880fe8f8ee5d095e9f24ee8c3dbd 100644 (file)
--- a/ext/B/B/Bblock.pm
+++ b/ext/B/B/Bblock.pm
@@ -140,3 +140,23 @@ sub compile {
 #     [The op after a pp_return] Omit
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Bblock - Walk basic blocks
+
+=head1 SYNOPSIS
+
+       perl -MO=Bblock[,OPTIONS] foo.pl
+
+=head1 DESCRIPTION
+
+See F<ext/B/README>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/Bytecode.pm b/ext/B/B/Bytecode.pm
index 447bd3700a065f6051ee85d081028e4d2a5b96a2..6c882b252304f74574d27742e601a8f56d43aabd 100644 (file)
--- a/ext/B/B/Bytecode.pm
+++ b/ext/B/B/Bytecode.pm
@@ -776,3 +776,23 @@ sub compile {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Bytecode - Perl compiler's bytecode backend
+
+=head1 SYNOPSIS
+
+       perl -MO=Bytecode[,SUBROUTINE] foo.pl
+
+=head1 DESCRIPTION
+
+See F<ext/B/README>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/C.pm b/ext/B/B/C.pm
index 4158bc40ac0078e8c8e0c67902b42989e86f51db..0669109327c7d222ce0f584524bd45788ad5b4ef 100644 (file)
--- a/ext/B/B/C.pm
+++ b/ext/B/B/C.pm
@@ -1199,3 +1199,23 @@ sub compile {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::C - Perl compiler's C backend
+
+=head1 SYNOPSIS
+
+       perl -MO=C[,OPTIONS] foo.pl
+
+=head1 DESCRIPTION
+
+See F<ext/B/README>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/CC.pm b/ext/B/B/CC.pm
index 4c877d9c5b1fed862bccb5e9d7948c62152de660..32c30333b8028889709bc9121676da510d8237b3 100644 (file)
--- a/ext/B/B/CC.pm
+++ b/ext/B/B/CC.pm
@@ -1526,3 +1526,23 @@ sub compile {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::CC - Perl compiler's optimized C translation backend
+
+=head1 SYNOPSIS
+
+       perl -MO=CC[,OPTIONS] foo.pl
+
+=head1 DESCRIPTION
+
+See F<ext/B/README>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/Debug.pm b/ext/B/B/Debug.pm
index d88cef378015b5e20ed799ebec5c006f3a51cedf..7754a5a8079e10e5c6d6cce2e410ec814ae7dc16 100644 (file)
--- a/ext/B/B/Debug.pm
+++ b/ext/B/B/Debug.pm
@@ -261,3 +261,23 @@ sub compile {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Debug - Walk Perl syntax tree, printing debug info about ops
+
+=head1 SYNOPSIS
+
+       perl -MO=Debug[,OPTIONS] foo.pl
+
+=head1 DESCRIPTION
+
+See F<ext/B/README>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/Disassembler.pm b/ext/B/B/Disassembler.pm
index 36db3548498d5076f3d385a21f18b3d6aefa5f8d..f26441d2d0626dc580e43e735e38975c0722d85f 100644 (file)
--- a/ext/B/B/Disassembler.pm
+++ b/ext/B/B/Disassembler.pm
@@ -142,3 +142,23 @@ sub disassemble_fh {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Disassembler - Disassemble Perl bytecode
+
+=head1 SYNOPSIS
+
+       use Disassembler;
+
+=head1 DESCRIPTION
+
+See F<ext/B/B/Disassembler.pm>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/Showlex.pm b/ext/B/B/Showlex.pm
index 9cf8ecc564338b94b4dc381156efadd34c02de9e..648f95dcc0a391f5c80667855864c0ed01826bf9 100644 (file)
--- a/ext/B/B/Showlex.pm
+++ b/ext/B/B/Showlex.pm
@@ -56,3 +56,25 @@ sub compile {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Showlex - Show lexical variables used in functions or files
+
+=head1 SYNOPSIS
+
+       perl -MO=Showlex[,SUBROUTINE] foo.pl
+
+=head1 DESCRIPTION
+
+When a subroutine name is provided in OPTIONS, prints the lexical
+variables used in that subroutine.  Otherwise, prints the file-scope
+lexicals in the file.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/Stackobj.pm b/ext/B/B/Stackobj.pm
index 8be047f19f332ba4768ce0c3e39713afa5e0f419..6df7acdcd49f135db07b2399cc544af3160f5349 100644 (file)
--- a/ext/B/B/Stackobj.pm
+++ b/ext/B/B/Stackobj.pm
@@ -279,3 +279,23 @@ sub B::Stackobj::Bool::write_back {
 sub B::Stackobj::Bool::invalidate {}
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Stackobj - Helper module for CC backend
+
+=head1 SYNOPSIS
+
+       use B::Stackobj;
+
+=head1 DESCRIPTION
+
+See F<ext/B/README>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/B/Terse.pm b/ext/B/B/Terse.pm
index 6489dc0afefbb8233ef1e4e0ab6f48ac54b19d8e..93757f34ce88d4bdb7a187997b60b7f92d00285e 100644 (file)
--- a/ext/B/B/Terse.pm
+++ b/ext/B/B/Terse.pm
@@ -130,3 +130,23 @@ sub B::SPECIAL::terse {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Terse - Walk Perl syntax tree, printing terse info about ops
+
+=head1 SYNOPSIS
+
+       perl -MO=Terse[,OPTIONS] foo.pl
+
+=head1 DESCRIPTION
+
+See F<ext/B/README>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/ext/B/O.pm b/ext/B/O.pm
index 40d336e12211fc67269d41a8ce3501b0cc3be055..3b0f0543e84177372e211bbc60657795f0a11812 100644 (file)
--- a/ext/B/O.pm
+++ b/ext/B/O.pm
@@ -19,3 +19,22 @@ sub import {
 
 1;
 
+__END__
+
+=head1 NAME
+
+O - Generic interface to Perl Compiler backends
+
+=head1 SYNOPSIS
+
+       perl -MO=Backend[,OPTIONS] foo.pl
+
+=head1 DESCRIPTION
+
+See F<ext/B/README>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut

diff --git a/sv.c b/sv.c
index edee80978254de04569a58f7d9ceb4e30972b9e1..46b51a344fff5d8762a5449ba522093a1efda703 100644 (file)
--- a/sv.c
+++ b/sv.c
@@ -3028,7 +3028,7 @@ sv_free(SV *sv)
        return;
 #ifdef DEBUGGING
     if (SvTEMP(sv)) {
-       warn("Attempt to free temp prematurely: %s", SvPEEK(sv));
+       warn("Attempt to free temp prematurely: SV 0x%lx", (unsigned long)sv);
        return;
     }
 #endif