Two straight comment patches seeking commitment: currently attached.
(to exception.c and headers.c)
--
Email and shopping with the feelgood factor!
55% of income to good causes. http://www.ippimail.comIndex: src/exceptions.c
===================================================================
--- src/exceptions.c (revision 25797)
+++ src/exceptions.c (working copy)
@@ -180,7 +180,9 @@
=item C<static void run_cleanup_action>
-RT#48260: Not yet documented!!!
+Takes an interpreter name and a stack pointer.
+Runs the action subroutine with an INTVAL arg of 0.
+Used in Parrot_push_action.
=cut
@@ -762,7 +764,10 @@
=item C<void destroy_exception_list>
-RT#48260: Not yet documented!!!
+Takes an interpreter name.
+Destroys (frees the memory allocated to) the exception buffers list and the
+associated exceptions free list for the specified interpreter.
+Uses really_destroy_exception_list (see below) to do the job.
=cut
@@ -779,7 +784,9 @@
=item C<void really_destroy_exception_list>
-RT#48260: Not yet documented!!!
+Takes a pointer to an exception (which had better be the last one in the list).
+Walks back through the list, freeing the memory of each one, until NULL encountered.
+Used by destroy_exception_list.
=cut
@@ -1000,7 +1007,8 @@
=item C<void Parrot_print_backtrace>
-RT#48260: Not yet documented!!!
+Display the primrose path to disaster, (the stack frames leading up to the abort).
+Used by Parrot_confess.
=cut
Index: src/headers.c
===================================================================
--- src/headers.c (revision 25797)
+++ src/headers.c (working copy)
@@ -726,7 +726,9 @@
=item C<static void free_pool>
-RT#48260: Not yet documented!!!
+Takes a pointer to a pool.
+Loops backwards through it, freeing all arenas and their associated objects.
+Used by sweep_cb_buf, sweep_cb_pmc, & Parrot_destroy_header_pools
=cut
@@ -750,7 +752,11 @@
=item C<static int sweep_cb_buf>
-RT#48260: Not yet documented!!!
+Take an interpreter name, pointer to an object pool, an unused argument,
+and a pointer to a boolean.
+Garbage-collect unused memory from the pool.
+Used by Parrot_destroy_header_pools.
+Returns 0.
=cut
@@ -781,7 +787,10 @@
=item C<static int sweep_cb_pmc>
-RT#48260: Not yet documented!!!
+Take an interpreter name and a pointer to a pool.
+Remove dead objects from the pool and free the memory.
+Returns 0.
+Used by sweep_cb_buf.
=cut
@@ -840,7 +849,10 @@
=item C<static void fix_pmc_syncs>
-RT#48260: Not yet documented!!!
+Takes pointers to an interpreter and a pool.
+Goes through the arena looking for shared objects and transferring
+them to the interpreter, so none get orphaned.
+Used by Parrot_merge_header_pools.
=cut
