From: Petter Urkedal <paurkedal@gmail.com>
Date: Thu, 29 Sep 2011 22:28:14 +0000 (+0200)
Subject: Add comment on GC_init_finalized_malloc.
X-Git-Tag: gc7_3alpha2~320^2~4
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8882a8e030a58d1c128c34d52e1242ec1967d9ee;p=gc

Add comment on GC_init_finalized_malloc.
---

diff --git a/include/gc_disclaim.h b/include/gc_disclaim.h
index 0437f724..269eeaa5 100644
--- a/include/gc_disclaim.h
+++ b/include/gc_disclaim.h
@@ -20,7 +20,9 @@
 /* This API is defined only if the library has been suitably compiled   */
 /* (i.e. with ENABLE_DISCLAIM defined).                                 */
 
-/* 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 a thread-safe function.                 */
 GC_API void GC_CALL GC_init_finalized_malloc(void);
 
 /* Type of a disclaim call-back, always stored along with closure data  */