Skip to content

Update sanitizers support documentation #333

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
mathbunnyru wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Update sanitizers support documentation #333

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16c9292
Update sanitizers support documentation
mathbunnyru Nov 14, 2025
d342b9e
Clarify sanitizer support instructions in documentation
mathbunnyru Nov 14, 2025
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
7 changes: 4 additions & 3 deletions doc/stack.qbk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,9 +294,10 @@ as stack space which suppresses the errors.

Sanitizers (GCC/Clang) are confused by the stack switches.
The library (and Boost.Context too) is required to be compiled with property (b2 command-line)
`context-impl=ucontext` and compilers santizer options.
Copy link
Author

@mathbunnyru mathbunnyru Nov 14, 2025

Choose a reason for hiding this comment

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

santizer -> sanitizer (typo)
compilers -> compiler (it's 1 compiler at a time)

Users must define `BOOST_USE_ASAN` before including any Boost.Context headers
when linking against Boost binaries.
Copy link
Author

@mathbunnyru mathbunnyru Nov 14, 2025

Choose a reason for hiding this comment

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

This is technically incorrect because there are no defines "when linking against Boost binaries"

`context-impl=ucontext` and [@https://www.boost.org/doc/contributor-guide/testing/sanitizers.html relevant b2 sanitizer options].

To use AddressSanitizer, you need to add `define=BOOST_USE_ASAN` to `b2` flags to compile Boost libraries,
and also define `BOOST_USE_ASAN` before including any Boost.Context headers in your code.

[endsect]

Expand Down