Skip to content

Commit d3483fc

Browse files
committed
Improve --with-address-sanitizer and pymalloc docs
1 parent 7659c24 commit d3483fc

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

Doc/c-api/memory.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -673,10 +673,8 @@ This allocator is disabled if Python is configured with the
673673
the :envvar:`PYTHONMALLOC` environment variable (ex: ``PYTHONMALLOC=malloc``).
674674
675675
Typically, it makes sense to disable the pymalloc allocator when building
676-
Python with AddressSanitizer (ASan) which helps uncover low level bugs within
677-
the C code. While pymalloc doesn't break under ASan, the ASan works more
678-
effectively with the system allocator (ASan does not track
679-
individual allocations done by pymalloc).
676+
Python with AddressSanitizer (:option:`--with-address-sanitizer`) which helps
677+
uncover low level bugs within the C code.
680678
681679
Customize pymalloc Arena Allocator
682680
----------------------------------

Doc/using/configure.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -802,6 +802,9 @@ Debug options
802802
.. option:: --with-address-sanitizer
803803

804804
Enable AddressSanitizer memory error detector, ``asan`` (default is no).
805+
To improve ASan detection capabilities you may also want to combine this
806+
with :option:`--without-pymalloc` to disable the specialized small-object
807+
allocator whose allocations are not tracked by ASan.
805808

806809
.. versionadded:: 3.6
807810

0 commit comments

Comments
 (0)