From 6c435abaa7793623953993ed01120ab5f1f9f2e6 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Thu, 24 Jan 2019 19:07:12 -0700 Subject: [PATCH] docs: clarify that only 3m supports incremental GC --- pkgs/racket-doc/scribblings/reference/memory.scrbl | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkgs/racket-doc/scribblings/reference/memory.scrbl b/pkgs/racket-doc/scribblings/reference/memory.scrbl index e2c39ad69f..b1cc902b4e 100644 --- a/pkgs/racket-doc/scribblings/reference/memory.scrbl +++ b/pkgs/racket-doc/scribblings/reference/memory.scrbl @@ -353,6 +353,9 @@ garbage-collection mode, depending on @racket[request]: The intent of incremental mode is to significantly reduce pause times due to major collections, but incremental mode typically implies longer minor-collection times and higher memory use. + Currently, incremental mode is only really supported when + @racket[(system-type 'gc)] returns @racket['3m]; it has no + effect in other Racket variants. If the @envvar{PLT_INCREMENTAL_GC} environment variable's value starts with @litchar{0}, @litchar{n}, or @litchar{N} on