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 30939f0bf0d5e960495a5b38035a6c35601d388f..e53e2a84900784f45713db39feea70cca3da2e41 100644 (file)
--- 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: