From 0fedbfa6a9d8a73c4adfa8f144acd2808676ea3a Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 11 Mar 2023 18:16:35 +0200 Subject: [PATCH] ; Minor improvement of documentation of GC thresholds * doc/lispref/internals.texi (Garbage Collection): More practical aspects of enlarging the GC threshold. --- doc/lispref/internals.texi | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi index 6a8aaf8ebaf..428d016b274 100644 --- a/doc/lispref/internals.texi +++ b/doc/lispref/internals.texi @@ -558,13 +558,15 @@ The initial threshold value is @code{GC_DEFAULT_THRESHOLD}, defined in value is 400,000 for the default 32-bit configuration and 800,000 for the 64-bit one. If you specify a larger value, garbage collection will happen less often. This reduces the amount of time spent garbage -collecting, but increases total memory use. You may want to do this -when running a program that creates lots of Lisp data. However, we +collecting (so Lisp programs will run faster between cycles of garbage +collection that happen more rarely), but increases total memory use. +You may want to do this when running a program that creates lots of +Lisp data, especially if you need it to run faster. However, we recommend against increasing the threshold for prolonged periods of time, and advise that you never set it higher than needed for the program to run in reasonable time. Using thresholds higher than -necessary could potentially cause system-wide memory pressure, and -should therefore be avoided. +necessary could potentially cause higher system-wide memory pressure, +and should therefore be avoided. You can make collections more frequent by specifying a smaller value, down to 1/10th of @code{GC_DEFAULT_THRESHOLD}. A value less than this minimum -- 2.39.2