add stub docs for ext/B, other minor tweaks

p4raw-id: //depot/perl@1518

17 files changed, 275 insertions, 3 deletions

diff --git a/Changes b/Changes
index 096ba0da34..a50e1aa851 100644
--- a/Changes
+++ b/Changes
@@ -69,6 +69,17 @@ 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
              Date:    Wed, 15 Jul 1998 03:47:56 EDT
diff --git a/Porting/config_H b/Porting/config_H
index 56de734300..b4d96217ef 100644
--- 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 c9144ca077..49f86c7de7 100644
--- 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 5897ef1013..dcf7809014 100644
--- 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 b77f15089f..340876b71b 100644
--- 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 0729b90f28..defcbdf958 100644
--- 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 125c8a3c65..a54431b4ce 100644
--- 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 447bd3700a..6c882b2523 100644
--- 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 4158bc40ac..0669109327 100644
--- 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 4c877d9c5b..32c30333b8 100644
--- 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 d88cef3780..7754a5a807 100644
--- 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 36db354849..f26441d2d0 100644
--- 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 9cf8ecc564..648f95dcc0 100644
--- 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 8be047f19f..6df7acdcd4 100644
--- 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 6489dc0afe..93757f34ce 100644
--- 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 40d336e122..3b0f0543e8 100644
--- 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 edee809782..46b51a344f 100644
--- 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