Skip to content

DOC: add dev docs on C debuggers and compiler sanitizers - #29757

Merged
mattip merged 3 commits into
numpy:mainfrom
ngoldbaum:sanitizer-docs
Sep 17, 2025
Merged

mattip merged 3 commits into
numpy:mainfrom
ngoldbaum:sanitizer-docs

Conversation

@ngoldbaum

Copy link
Copy Markdown
Member

Fixes #29079

Adds developer-focused docs on how to use C debuggers and compiler sanitizers.

I'd appreciate it if people could actually try this on their local setups and let me know if they hit any sticking points. I'm not sure how in-the-weeds I should get.

@ngoldbaum

Copy link
Copy Markdown
Member Author

Yikes - looks like docker is having issues. I'll kick this later.

In the meantime - ping @lucascolley, you totally nerd-sniped me scipy/scipy#23612 (comment)

@stefanv

stefanv commented Sep 15, 2025

Copy link
Copy Markdown
Contributor

Great write-up; thanks for adding this, @ngoldbaum!

You may see memory leaks coming from the Python interpreter, particularly on
MacOS. If the memory leak reports are not useful, you can disable leak detection
by passing ``detect_leaks=0`` in ``ASAN_OPTIONS``. You can pass more than one
option using a comma-delimited list, like this:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should say colon-delimited

@lucascolley lucascolley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @ngoldbaum, this looks great!

Let's see how nerd-sniped I am to make lines 357 to 392 as easy as pixi run build-asan :)

@lucascolley

Copy link
Copy Markdown
Contributor

check out rgommers/pixi-dev-scipystack#50 if you get a chance!

ngoldbaum and others added 2 commits September 16, 2025 14:01
[skip actions] [skip azp] [skip cirrus]
@mattip

mattip commented Sep 17, 2025

Copy link
Copy Markdown
Member

Let's put this in as-is, we can iterate on it as the tools develop and people try to use the information. Thanks @ngoldbaum

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: add developer docs for running numpy tests and scripts under ASAN and TSAN

5 participants