Commits

Martin von Löwis committed 5caf80f

Mention that DEBUG_LEAK includes DEBUG_SAVEALL. Fixes #1170460.

Comments (0)

Files changed (1)

Doc/lib/libgc.tex

 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:
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.