From 0e0426a150c2ca4c1c7279d15cf338c0f0f5e3f9 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Mon, 6 Jun 2011 20:22:36 -0700 Subject: [PATCH] document scheme_enable_garbage_collection() --- collects/scribblings/inside/memory.scrbl | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/collects/scribblings/inside/memory.scrbl b/collects/scribblings/inside/memory.scrbl index f224b76f83..24ec5f56ed 100644 --- a/collects/scribblings/inside/memory.scrbl +++ b/collects/scribblings/inside/memory.scrbl @@ -1009,6 +1009,18 @@ See @cpp{scheme_dont_gc_ptr}.} Forces an immediate garbage-collection.} +@function[(void scheme_enable_garbage_collection [int on])]{ + +Garbage collection is enabled only when an internal counter is +@cpp{0}. Calling @cpp{scheme_enable_garbage_collection} with a false +value increments the counter, and calling +@cpp{scheme_enable_garbage_collection} with a true value decrements +the counter. + +When the @envvar{PLTDISABLEGC} environment variable is set, then +@exec{racket} initializes the internal counter to @cpp{1} to initially +disable garbage collection.} + @function[(void GC_register_traversers [short tag]