gc

$Revision: 5.0.2.3 $

Function

Package: EXCL

Arguments: (&optional mode error)

This function can be used to trigger a scavenge or global gc and to toggle some gsgc switches. The behavior depends on the mode argument. Possible values for mode and their effects are shown in the table below.

The error argument ...

See gc.htm for general information on garbage collection. The general documentation description is in introduction.htm. The index is in index.htm.

Value of mode	Action
nil	Perform a scavenge. This is the default.
t	Perform a global garbage collection.
:mark-for-tenure	Mark all surviving objects so that they are tenured as soon as convenient and perform a scevenge. Some or all of these objects may be tenured during the current scavenge and some (perhaps all) may be tenured during a later scavenge.
:tenure	Perform a scavenge and tenure all surviving objects. All will be tenured when the call to gc completes (contrast with :mark-for-tenure, where some surviving objects may not be tenured after the call completes). Note that (gc :tenure) will likely take appreciably more time than (gc :mark-for-tenure).
:show	Print the names and current values of gc switches and parameters. This argument does not trigger a scavenge or global gc.
:room	Equivalent to (room t). This argument does not trigger a scavenge or global gc.
:print	Toggles whether messages are printed when a gc occurs. This argument does not trigger a scavenge or global gc.
:help	Prints the list of acceptable values for the type argument. This argument does not trigger a scavenge or global gc.