From: Richard M. Stallman <rms@gnu.org>
Date: Mon, 7 Jul 2003 20:39:40 +0000 (+0000)
Subject: (Fgarbage_collect): Doc fix.
X-Git-Tag: ttn-vms-21-2-B4~9459
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=e1e375966ecb9d48709c2717701e3fde80390307;p=emacs.git

(Fgarbage_collect): Doc fix.
---

diff --git a/src/alloc.c b/src/alloc.c
index 169d292c1b3..c31132820bb 100644
--- a/src/alloc.c
+++ b/src/alloc.c
@@ -4255,13 +4255,15 @@ inhibit_garbage_collection ()
 
 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;