From 4abe7b8300a89d4b8c3b3277076e76f20754b27e Mon Sep 17 00:00:00 2001
From: Kaz Kylheku <kaz@kylheku.com>
Date: Fri, 10 Apr 2020 23:23:49 -0700
Subject: gc: add argument to sys:gc.

* gc.c (gc_wrap): Takes argument for requesting full garbage
collection.
(gc_late_init): Update registration of gc intrinsic.

* txr.1: Documented.
---
 txr.1 | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'txr.1')

diff --git a/txr.1 b/txr.1
index 7b8dd653..417a656f 100644
--- a/txr.1
+++ b/txr.1
@@ -64245,7 +64245,7 @@ operator.
 .SS* Garbage Collection
 .coNP Function @ sys:gc
 .synb
-.mets (sys:gc)
+.mets (sys:gc <> [ full ])
 .syne
 .desc
 The
@@ -64259,6 +64259,16 @@ The function returns
 if garbage collection is disabled (and consequently nothing is done), otherwise
 .codn t .
 
+The Boolean
+.meta full
+argument, defaulting to
+.codn nil ,
+indicates whether a full garbage collection should be requested.
+
+Even if this argument is
+.codn nil ,
+a full garbage collection may occur due to having been scheduled.
+
 .coNP Function @ sys:gc-set-delta
 .synb
 .mets (sys:gc-set-delta << bytes )
-- 
cgit v1.2.3