# HG changeset patch
# User Richard M. Stallman <rms@gnu.org>
# Date 1057610380 0
# Node ID 43d663a05e2d9113e816fc4f3d548d3137b6a14a
# Parent  10f90558dc890f88a9443dee158d1c246cabc6ff
(Fgarbage_collect): Doc fix.

diff -r 10f90558dc89 -r 43d663a05e2d src/alloc.c
--- a/src/alloc.c	Mon Jul 07 18:53:42 2003 +0000
+++ b/src/alloc.c	Mon Jul 07 20:39:40 2003 +0000
@@ -4255,13 +4255,15 @@
 
 DEFUN ("garbage-collect", Fgarbage_collect, Sgarbage_collect, 0, 0, "",
        doc: /* Reclaim storage for Lisp objects no longer needed.
-Returns info on amount of space in use:
+Garbage collection happens automatically if you cons more than
+`gc-cons-threshold' bytes of Lisp data since previous garbage collection.
+`garbage-collect' normally returns a list with info on amount of space in use:
  ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
   (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
   (USED-FLOATS . FREE-FLOATS) (USED-INTERVALS . FREE-INTERVALS)
   (USED-STRINGS . FREE-STRINGS))
-Garbage collection happens automatically if you cons more than
-`gc-cons-threshold' bytes of Lisp data since previous garbage collection.  */)
+However, if there was overflow in pure space, `garbage-collect'
+returns nil, because real GC can't be done.  */)
      ()
 {
   register struct specbinding *bind;