]> granicus.if.org Git - gc/commitdiff
Add comment on GC_init_finalized_malloc.
authorPetter Urkedal <paurkedal@gmail.com>
Thu, 29 Sep 2011 22:28:14 +0000 (00:28 +0200)
committerPetter Urkedal <paurkedal@gmail.com>
Thu, 29 Sep 2011 22:28:14 +0000 (00:28 +0200)
include/gc_disclaim.h

index f09bc9d6a160712c50936ceecdc6bdf0598210e6..44b29d494de62c10c8fb5ae21c85901b1b5f1ecf 100644 (file)
@@ -48,8 +48,9 @@ struct GC_finalizer_closure {
 GC_API void *GC_CALL GC_finalized_malloc(size_t /*size*/,
                                         struct GC_finalizer_closure * /*fc*/);
 
-/* Prepare the object kind used for GC_finalized_malloc.                */
+/* Prepare the object kind used by GC_finalized_malloc.  Call it from   */
+/* your initialization code or, at least, at some point before using    */
+/* finalized allocation.  It is idempotent and thread-safe.             */
 GC_API void GC_CALL GC_init_finalized_malloc(void);
-        // FIXME: replace init with enable?
 
 #endif