[pypy-svn] r77003 - pypy/branch/gc-module/pypy/module/gc

[arigo at codespeak.net]

Author: arigo
Date: Fri Sep 10 17:17:11 2010
New Revision: 77003

Modified:
   pypy/branch/gc-module/pypy/module/gc/referents.py
Log:
Add documentation.


Modified: pypy/branch/gc-module/pypy/module/gc/referents.py
==============================================================================
--- pypy/branch/gc-module/pypy/module/gc/referents.py	(original)
+++ pypy/branch/gc-module/pypy/module/gc/referents.py	Fri Sep 10 17:17:11 2010
@@ -149,5 +149,14 @@
 get_referrers.unwrap_spec = [ObjSpace, 'args_w']
 
 def dump_rpy_heap(space, fd):
+    """Write a full dump of the objects in the heap to the given file
+    descriptor.  Format for each object (each item is one machine word):
+
+        [addr] [typeindex] [size] [addr1]..[addrn] [-1]
+
+    where [addr] is the address of the object, [typeindex] and [size]
+    are as get_rpy_type_index() and get_rpy_memory_usage() would return,
+    and [addr1]..[addrn] are addresses of other objects that this object
+    points to."""
     rgc.dump_rpy_heap(fd)
 dump_rpy_heap.unwrap_spec = [ObjSpace, int]