[svn:parrot] r38557 - branches/gc_api/src/gc

[whiteknight at svn.parrot.org]

Author: whiteknight
Date: Thu May  7 23:48:58 2009
New Revision: 38557
URL: https://trac.parrot.org/parrot/changeset/38557

Log:
[gc_api] add a small comment note about how buffer-like headers are only used in one place right now apparently, and we might be able to repurpose the concept for something else later

Modified:
   branches/gc_api/src/gc/api.c

Modified: branches/gc_api/src/gc/api.c
==============================================================================
--- branches/gc_api/src/gc/api.c	Thu May  7 23:39:34 2009	(r38556)
+++ branches/gc_api/src/gc/api.c	Thu May  7 23:48:58 2009	(r38557)
@@ -226,6 +226,9 @@
 =item C<void * new_bufferlike_header(PARROT_INTERP, size_t size)>
 
 Returns a new buffer-like header from the appropriate sized pool.
+A "bufferlike object" is an object that is considered to be isomorphic to the
+PObj, so it will participate in normal GC. At the moment these are only used
+to create ListChunk objects in src/list.c.
 
 =cut