Skip to content

Improve documentation for using sanitizers - #1926

Merged
encukou merged 2 commits into
python:mainfrom
StanFromIreland:rework-sans
Oct 20, 2026
Merged

encukou merged 2 commits into
python:mainfrom
StanFromIreland:rework-sans

Conversation

@StanFromIreland

Copy link
Copy Markdown
Member

As discussed in #746, this updates the information on using CPython with sanitisers. The page contained a lot of information about setting up Clang, which I removed. The devguide isn't the place for it, I presume when it was written the information was less readily available (and, nowadays you're probably not going to go through the trouble of building LLVM yourself ;-). The page is now focused on our flags/setup.

@read-the-docs-community

read-the-docs-community Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 CPython devguide | 🛠️ Build #35261998 | 📁 Comparing 6c0522b against latest (d773e39)

  🔍 Preview build  

6 files changed · + 1 added · ± 5 modified

+ Added

± Modified

@encukou encukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for taking this on!

Comment thread development-tools/clang.rst
Comment thread conf.py

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'python': ('https://docs.python.org/dev', None),

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not saying this is a bad change, but I think it should go in a separate PR, for visibility & revertability.

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.

It's needed for HWAsan's option, and IMO, since the devguide generally documents current information, this should be ok?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

OK, let's keep it here.

@encukou encukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

@encukou
encukou merged commit 2b19e76 into python:main Oct 20, 2026
5 checks passed
@StanFromIreland
StanFromIreland deleted the rework-sans branch October 20, 2026 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants