Change 13697 by jhi@alpha on 2001/12/15 17:12:32
Subject: [PATCH ext/B/B/Bblock.pm] Some weak docs
From: Michael G Schwern <[EMAIL PROTECTED]>
Date: Fri, 14 Dec 2001 19:59:13 -0500
Message-ID: <20011215005913.GC28596@blackrider>
Affected files ...
.... //depot/perl/ext/B/B/Bblock.pm#12 edit
Differences ...
==== //depot/perl/ext/B/B/Bblock.pm#12 (text) ====
Index: perl/ext/B/B/Bblock.pm
--- perl/ext/B/B/Bblock.pm.~1~ Sat Dec 15 10:15:06 2001
+++ perl/ext/B/B/Bblock.pm Sat Dec 15 10:15:06 2001
@@ -168,7 +168,12 @@
=head1 SYNOPSIS
- perl -MO=Bblock[,OPTIONS] foo.pl
+ # External interface
+ perl -MO=Bblock[,OPTIONS] foo.pl
+
+ # Programmatic API
+ use B::Bblock qw(find_leaders);
+ my $leaders = find_leaders($root_op, $start_op);
=head1 DESCRIPTION
@@ -176,6 +181,35 @@
A basic block is a series of operations which is known to execute from
start to finish, with no possiblity of branching or halting.
+It can be used either stand alone or from inside another program.
+
+=for _private
+Somebody who understands the stand-alone options document them, please.
+
+=head2 Functions
+
+=over 4
+
+=item B<find_leaders>
+
+ my $leaders = find_leaders($root_op, $start_op);
+
+Given the root of the op tree and an op from which to start
+processing, it will return a hash ref representing all the ops which
+start a block.
+
+=for _private
+The above description may be somewhat wrong.
+
+The values of %$leaders are the op objects themselves. Keys are $$op
+addresses.
+
+=for _private
+Above cribbed from B::CC's comments. What's a $$op address?
+
+=back
+
+
=head1 AUTHOR
Malcolm Beattie, C<[EMAIL PROTECTED]>
End of Patch.
