summaryrefslogtreecommitdiffstats
path: root/Misc
diff options
context:
space:
mode:
authorSanyam Khurana <8039608+CuriousLearner@users.noreply.github.com>2018-11-20 11:10:49 (GMT)
committerƁukasz Langa <lukasz@langa.pl>2018-11-20 11:10:49 (GMT)
commitd5d33681c1cd1df7731eb0fb7c0f297bc2f114e6 (patch)
treeb9a6e306c848102281e41903d1c499a85bb3afbd /Misc
parent8b9c33ea9ce902f902c9d9900121010801950547 (diff)
downloadcpython-d5d33681c1cd1df7731eb0fb7c0f297bc2f114e6.zip
cpython-d5d33681c1cd1df7731eb0fb7c0f297bc2f114e6.tar.gz
cpython-d5d33681c1cd1df7731eb0fb7c0f297bc2f114e6.tar.bz2
bpo-18859: Document --with-valgrind option in README.valgrind (#10591)
Diffstat (limited to 'Misc')
-rw-r--r--Misc/README.valgrind8
1 files changed, 8 insertions, 0 deletions
diff --git a/Misc/README.valgrind b/Misc/README.valgrind
index 908f137..b483b2e 100644
--- a/Misc/README.valgrind
+++ b/Misc/README.valgrind
@@ -2,6 +2,10 @@ This document describes some caveats about the use of Valgrind with
Python. Valgrind is used periodically by Python developers to try
to ensure there are no memory leaks or invalid memory reads/writes.
+If you want to enable valgrind support in Python, you will need to
+configure Python --with-valgrind option or an older option
+--without-pymalloc.
+
UPDATE: Python 3.6 now supports PYTHONMALLOC=malloc environment variable which
can be used to force the usage of the malloc() allocator of the C library.
@@ -46,6 +50,10 @@ If you disable PyMalloc, most of the information in this document and
the supplied suppressions file will not be useful. As discussed above,
disabling PyMalloc can catch more problems.
+PyMalloc uses 256KB chunks of memory, so it can't detect anything
+wrong within these blocks. For that reason, compiling Python
+--without-pymalloc usually increases the usefulness of other tools.
+
If you use valgrind on a default build of Python, you will see
many errors like: