Skip to content

Improve documentation for using sanitizers #1926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
StanFromIreland wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve documentation for using sanitizers #1926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
179791b
Improve documentation for using sanitizers
StanFromIreland Oct 16, 2026
6c0522b
Address Petr's comment
StanFromIreland Oct 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,13 @@

rediraffe_redirects = {
# Development Tools
"clang.rst": "development-tools/clang.rst",
"clang.rst": "development-tools/sanitizers.rst",
"gdb.rst": "development-tools/gdb.rst",
# Advanced Tools was renamed Development Tools in gh-1149
"advanced-tools/clang.rst": "development-tools/clang.rst",
"advanced-tools/clang.rst": "development-tools/sanitizers.rst",
"advanced-tools/gdb.rst": "development-tools/gdb.rst",
# "Dynamic analysis with Clang" was reworked into "Sanitizers"
"development-tools/clang.rst": "development-tools/sanitizers.rst",
# Core team
"coredev.rst": "core-team/join-team.rst",
"committing.rst": "core-team/committing.rst",
Expand Down Expand Up @@ -241,7 +243,7 @@
}

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

@encukou encukou Oct 19, 2026

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.

@StanFromIreland StanFromIreland Oct 20, 2026

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?

'diataxis': ('https://diataxis.fr/', None),
}

Expand Down
289 changes: 0 additions & 289 deletions development-tools/clang.rst
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion development-tools/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
.. _development-tools:

=================
Expand All @@ -9,5 +9,5 @@

clinic/index
gdb
clang
sanitizers
warnings
Loading
Loading