# HG changeset patch
# User Luc Teirlinck <teirllm@auburn.edu>
# Date 1148941585 0
# Node ID e610fb70748af9fb74ac90cc09a442340bdc6745
# Parent  495e2dcf939296f36ebc8ddff9dd1e895dee6192
(Pure Storage): Mention that an overflow in pure
space causes a memory leak.
(Garbage Collection): If there was an overflow in pure space,
`garbage-collect' returns nil.

diff -r 495e2dcf9392 -r e610fb70748a lispref/internals.texi
--- a/lispref/internals.texi	Mon May 29 22:23:38 2006 +0000
+++ b/lispref/internals.texi	Mon May 29 22:26:25 2006 +0000
@@ -160,7 +160,8 @@
 the part that didn't fit.  If that happens, you should increase the
 compilation parameter @code{PURESIZE} in the file
 @file{src/puresize.h} and rebuild Emacs, even though the resulting
-image will work.  Such an overflow normally won't happen unless you
+image will work: garbage collection is disabled in this situation,
+causing a memory leak.  Such an overflow normally won't happen unless you
 try to preload additional libraries or add features to the standard
 ones.  Emacs will display a warning about the overflow when it
 starts.
@@ -348,6 +349,10 @@
 object consists of a header and the storage for the string text
 itself; the latter is only allocated when the string is created.)
 @end table
+
+If there was overflow in pure space (see the previous section),
+@code{garbage-collect} returns @code{nil}, because a real garbage
+collection can not be done in this situation.
 @end deffn
 
 @defopt garbage-collection-messages