cpython/Doc/using
Miss Islington (bot) cce38eefd4
[3.14] Doc/c-api/memory.rst: extend --without-pymalloc doc with ASan information (GH-136790) (GH-136798)
Extend the documentation for disabling pymalloc with the `--without-pymalloc` flag regarding why it is worth to use it when enabling AddressSanitizer for Python build (which is done, e.g., in CPython's CI builds).

I have tested the CPython latest main build with both ASan and pymalloc enabled and it seems to work just fine. I did run the `python -m test` suite which didn't uncover any ASan crashes (though, it detected some memory leaks, which I believe are irrelevant here).

I have discussed ASan and this flag with @encukou on the CPython Core sprint on EuroPython 2025. We initially thought that the `--without-pymalloc` flag is needed for ASan builds due to the fact pymalloc must hit the begining of page when determining if the memory to be freed comes from pymalloc or was allocated by the system malloc. In other words, we thought, that ASan would crash CPython during free of big objects (allocated by system malloc). It may be that this was the case in the past, but it is not the case anymore as the `address_in_range` function used by pymalloc is annotated to be skipped from the ASan instrumentation.


(cherry picked from commit d19bb44713)

Co-authored-by: Disconnect3d <dominik.b.czarnota@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-07-20 10:55:06 +02:00
..
android.rst [3.14] gh-131531: android.py enhancements to support cibuildwheel (GH-132870) (#135158) 2025-06-05 14:24:52 +08:00
cmdline.rst [3.14] Docs: Fix duplicate word typos (GH-135958) (GH-136007) 2025-06-27 00:05:53 +00:00
configure.rst [3.14] Doc/c-api/memory.rst: extend --without-pymalloc doc with ASan information (GH-136790) (GH-136798) 2025-07-20 10:55:06 +02:00
editors.rst gh-59149: Setup documentation for IDLE on Linux and add section in Editors (#130003) 2025-02-12 03:16:56 -05:00
index.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
ios.rst [3.14] gh-135966: Modify iOS testbed to make app_packages a site directory (GH-135967) (#136012) 2025-06-27 13:30:51 +08:00
mac.rst [3.14] gh-119132: Update 'Using Python on macOS' documentation. (GH-135591) (#135594) 2025-06-16 19:43:24 -04:00
mac_installer_01_introduction.png gh-124720: Update "Using Python on a Mac" document (#124721) 2024-09-30 07:39:46 +08:00
mac_installer_02_readme.png gh-124720: Update "Using Python on a Mac" document (#124721) 2024-09-30 07:39:46 +08:00
mac_installer_03_license.png gh-124720: Update "Using Python on a Mac" document (#124721) 2024-09-30 07:39:46 +08:00
mac_installer_04_installation_type.png gh-124720: Update "Using Python on a Mac" document (#124721) 2024-09-30 07:39:46 +08:00
mac_installer_05_custom_install.png gh-124720: Update "Using Python on a Mac" document (#124721) 2024-09-30 07:39:46 +08:00
mac_installer_06_summary.png gh-124720: Update "Using Python on a Mac" document (#124721) 2024-09-30 07:39:46 +08:00
mac_installer_07_applications.png gh-124720: Update "Using Python on a Mac" document (#124721) 2024-09-30 07:39:46 +08:00
mac_installer_08_install_certificates.png gh-124720: Update "Using Python on a Mac" document (#124721) 2024-09-30 07:39:46 +08:00
mac_installer_09_custom_install_free_threaded.png gh-124720: Update "Using Python on a Mac" document (#124721) 2024-09-30 07:39:46 +08:00
unix.rst Docs: fix shell command formatting (#131310) 2025-03-19 09:42:47 +02:00
win_install_freethreaded.png gh-112984 Update Windows build and installer for free-threaded builds (GH-113129) 2024-01-17 21:52:23 +00:00
win_installer.png Optimize images by IMGbot (GH-21348) 2022-02-04 15:49:43 +09:00
windows.rst [3.14] Further improves Advanced installation docs for PyManager (GH-134541) (GH-134576) 2025-05-23 10:23:06 +00:00