[Python-checkins] bpo-18859: Document --with-valgrind option in README.valgrind (#10591)

Łukasz Langa webhook-mailer at python.org
Tue Nov 20 06:11:02 EST 2018

commit: d5d33681c1cd1df7731eb0fb7c0f297bc2f114e6
branch: master
author: Sanyam Khurana <8039608+CuriousLearner at users.noreply.github.com>
committer: Łukasz Langa <lukasz at langa.pl>
date: 2018-11-20T12:10:49+01:00

bpo-18859: Document --with-valgrind option in README.valgrind (#10591)

M Misc/README.valgrind

diff --git a/Misc/README.valgrind b/Misc/README.valgrind
index 908f137eff07..b483b2ea60a4 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
 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:

More information about the Python-checkins mailing list