summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArmin Rigo <arigo@tunes.org>2003-10-28 12:10:38 (GMT)
committerArmin Rigo <arigo@tunes.org>2003-10-28 12:10:38 (GMT)
commit3be6d5d3204165247d0fd0751797c5c9ee4fbc1d (patch)
treef084e47da44f181b3a80660582d5b88ecdbff48b
parent2b3eb4062c5e50abf854f7e68038243ca7c07217 (diff)
downloadcpython-3be6d5d3204165247d0fd0751797c5c9ee4fbc1d.zip
cpython-3be6d5d3204165247d0fd0751797c5c9ee4fbc1d.tar.gz
cpython-3be6d5d3204165247d0fd0751797c5c9ee4fbc1d.tar.bz2
Documented gc.get_referrers() as dangerous.
SF bug 793822
-rw-r--r--Doc/lib/libgc.tex5
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/lib/libgc.tex b/Doc/lib/libgc.tex
index 2477584..f256434 100644
--- a/Doc/lib/libgc.tex
+++ b/Doc/lib/libgc.tex
@@ -96,6 +96,11 @@ be listed among the resulting referrers. To get only currently live
objects, call \function{collect()} before calling
\function{get_referrers()}.
+Care must be taken when using objects returned by
+\function{get_referrers()} because some of them could still be under
+construction and hence in a temporarily invalid state. Avoid using
+\function{get_referrers()} for any purpose other than debugging.
+
\versionadded{2.2}
\end{funcdesc}