From: Martin v. Löwis <martin@v.loewis.de>
Date: Mon, 28 Mar 2005 15:29:28 +0000 (+0000)
Subject: Mention that DEBUG_LEAK includes DEBUG_SAVEALL. Fixes #1170460.
X-Git-Tag: v2.5a0~1871
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0f9679d2b03b29cfcfd272f0d17bb1a6e88ae812;p=python

Mention that DEBUG_LEAK includes DEBUG_SAVEALL. Fixes #1170460.
Will backport to 2.4.
---

diff --git a/Doc/lib/libgc.tex b/Doc/lib/libgc.tex
index 30939f0bf0..e53e2a8490 100644
--- a/Doc/lib/libgc.tex
+++ b/Doc/lib/libgc.tex
@@ -14,7 +14,9 @@ collector supplements the reference counting already used in Python, you
 can disable the collector if you are sure your program does not create
 reference cycles.  Automatic collection can be disabled by calling
 \code{gc.disable()}.  To debug a leaking program call
-\code{gc.set_debug(gc.DEBUG_LEAK)}.
+\code{gc.set_debug(gc.DEBUG_LEAK)}. Notice that this includes 
+\code{gc.DEBUG_SAVEALL}, causing garbage-collected objects to be
+saved in gc.garbage for inspection.
 
 The \module{gc} module provides the following functions: