Author: particle
Date: Fri Jan 27 11:13:48 2006
New Revision: 11359
Modified:
trunk/docs/dev/optimizer.pod
trunk/docs/dev/pmc_freeze.pod
trunk/docs/dev/wranglers.pod
Log:
docs: minor whitespace, spelling, grammar, and other fixes to dev docs
Modified: trunk/docs/dev/optimizer.pod
==============================================================================
--- trunk/docs/dev/optimizer.pod (original)
+++ trunk/docs/dev/optimizer.pod Fri Jan 27 11:13:48 2006
@@ -10,7 +10,7 @@ This document describes how the IMCC opt
=head1 DESCRIPTION
-The objective of the IMCC optimizer is to take a PASM function as input and
+The objective of the IMCC optimizer is to take a PASM function as input and
apply code-improving transformations to it to be more efficient, i.e. improving
execution time and reducing code size. It must do this while preserving the
same code behavior.
@@ -24,7 +24,7 @@ be optimized.
=item IMC_Unit
-The IMC_Unit structure contains all the information known about a function.
+The IMC_Unit structure contains all the information known about a function.
It is passed in to each optimizer method.
=item Instruction
@@ -43,10 +43,10 @@ list. To iterate through all Instructio
Basic blocks are the most important structure for optimization. A basic block
identifies a block of instructions that will all execute in sequence without
jumps into or out of that block. All labels will appear at the beginning of a
-block, and all conditional or unconditional jumps will appear at the end.
+block, and all conditional or unconditional jumps will appear at the end.
Basic_block structures are stored as an array of pointers, each with an index
that denotes their position in the array. Block 0 is implicitly the top block.
- To iterate through all Basic_blocks, use:
+To iterate through all Basic_blocks, use:
int i;
for (i = 0; i < unit->n_basic_blocks; i++) {
@@ -76,7 +76,7 @@ depth of the loop.
=item Set
Set is a useful structure for defining sets of integers, which map to indexes
-of structures. This is used most often to create sets of Basic_blocks.
+of structures. This is used most often to create sets of Basic_blocks.
Dominators, dominance frontiers, and loops use Set. A Set must be a defined
size, and cannot grow or shrink. Most standard set operations are implemented:
add, contains, copy, equal, union, and intersection.
@@ -87,7 +87,7 @@ add, contains, copy, equal, union, and i
Optimizations are organized into an optimization loop within imc_reg_alloc() in
reg_alloc.c. The ordering is based on the amount of CFG information needed by
-each group of optimizations: pre_optimize(), cfg_optimize(), and optimize().
+each group of optimizations: pre_optimize(), cfg_optimize(), and optimize().
Each optimization function (group and individual) returns an int, with TRUE
denoting that an optimization has been performed and a change to the code has
been made. The power of the optimizer is that performing one optimization may
Modified: trunk/docs/dev/pmc_freeze.pod
==============================================================================
--- trunk/docs/dev/pmc_freeze.pod (original)
+++ trunk/docs/dev/pmc_freeze.pod Fri Jan 27 11:13:48 2006
@@ -28,8 +28,8 @@ example:
=item freeze
-Called from user code to serialize the state of a PMC into some (possibly
- binary) representation held in a STRING.
+Called from user code to serialize the state of a PMC into some (possibly
+binary) representation held in a STRING.
=item freeze_at_destruct
@@ -60,8 +60,8 @@ destroyed in an appropriate order. This
Mark all objects as being live by calling B<pobject_lives> called from DOD.
While the functionality is the same, it will not be implemented on top of this
-general scheme for performance reasons. This leads to some code duplication,
- but DOD is run permanently and deserves all the speed it can get.
+general scheme for performance reasons. This leads to some code duplication,
+but DOD is run permanently and deserves all the speed it can get.
=back
@@ -150,8 +150,8 @@ to be remembered.
Using a B<Hash> is one method to avoid duplicates. The B<seen> hash holds keys
being the address of the PMC and values being a PMC B<id>, which is unique for
-this PMC. While this is straight forward, it consumes 16 bytes per PMC (plus
- overhead, 32-bit system assumed). Hash lookups also take a considerable
+this PMC. While this is straight forward, it consumes 16 bytes per PMC (plus
+overhead, 32-bit system assumed). Hash lookups also take a considerable
amount of time.
=item B<next_for_GC>
Modified: trunk/docs/dev/wranglers.pod
==============================================================================
--- trunk/docs/dev/wranglers.pod (original)
+++ trunk/docs/dev/wranglers.pod Fri Jan 27 11:13:48 2006
@@ -11,7 +11,7 @@ docs/dev/wranglers.pod - Tips for Bug Wr
This document attempts to outline a set of "best practices" for dealing with
bugs in Parrot's RT system. It is targeted at Parrot developers and "Bug
Wranglers" and is I<not> intended as advice or instruction for end users. Bug
-filing procedures for end user's are documented in F<docs/submissions.pod>.
+filing procedures for end users are documented in F<docs/submissions.pod>.
=head1 WHAT IS A BUG WRANGLER?
@@ -22,10 +22,9 @@ tracker in a healthy state. I<This mean
=head1 WHERE IS IT?
The Parrot bug tracker is currently the same as the I<Perlbug> system used for
-Perl5 Development. It is available via HTTP at L<http://bugs.perl.org> (XXX is
-this the official URL?).
+Perl5 Development. It is available via HTTP at L<http://rt.perl.org>.
-=head1 BUG HANDLING PROCEDURES
+=head1 BUG HANDLING PROCEDURES
=head2 New Bugs
@@ -62,7 +61,9 @@ Make sure that there is actually a patch
=over 4
-=item * Claim ownership or interest ( CC ) of the ticket. In this way you will
be received further correspondence about the ticket.
+=item * Claim ownership or interest ( CC ) of the ticket.
+
+This way you will receive further correspondence about the ticket.
=item * Run the test suite
@@ -96,7 +97,7 @@ response from the requestor change the s
If it's a [PATCH] bug it's possible that the patch was applied but the
bug/patch status was never changed. Also, not all list traffic regarding a
bug ends up in RT. It's best to look at the SVN repo to attempt to determine
if
-the bug actual was resolved.
+the bug was resolved.
=back
