summaryrefslogtreecommitdiffstats
path: root/Lib/test/leakers/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Lib/test/leakers/README.txt')
-rw-r--r--Lib/test/leakers/README.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/Lib/test/leakers/README.txt b/Lib/test/leakers/README.txt
new file mode 100644
index 0000000..801ed95
--- /dev/null
+++ b/Lib/test/leakers/README.txt
@@ -0,0 +1,18 @@
+This directory contains test cases that are known to leak references.
+The idea is that you can import these modules while in the interpreter
+and call the leak function repeatedly. This will only be helpful if
+the interpreter was built in debug mode. If the total ref count
+doesn't increase, the bug has been fixed.
+
+Here's an example interpreter session for test_gestalt which still leaks:
+
+>>> from test.leakers.test_gestalt import leak
+[24275 refs]
+>>> leak()
+[28936 refs]
+>>> leak()
+[28938 refs]
+>>> leak()
+[28940 refs]
+>>>
+