Skip to content
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.

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

--sanitizers configuration option lacks documentation #240

Open
vpax opened this issue Jan 7, 2024 · 3 comments
Open

--sanitizers configuration option lacks documentation #240

vpax opened this issue Jan 7, 2024 · 3 comments

Comments

@vpax
Copy link
Contributor

vpax commented Jan 7, 2024

As best as I can tell, the --sanitizers option is not documented anywhere other than (in a quite limited form) some discussion in the Spicy documentation. A basic question is which ones are available under what compilers/platforms.

@awelzel
Copy link
Contributor

awelzel commented Jan 8, 2024

A basic question is which ones are available under what compilers/platforms.

I think this we should leave up to other documentation and the developer to understand compiler and platform features. As likely it's stale/version dependent, too. Maybe instead document in a generic way that --sanitizers sets -fsanitize=... compiler option and that there's some special handling of undefined and optimizations?

We could provide links to fsanitize for GCC and clang if that's helpful?

https://gcc.gnu.org/onlinedocs/gcc/Instrumentation-Options.html

@timwoj
Copy link
Member

timwoj commented Jan 8, 2024

I think this we should leave up to other documentation and the developer to understand compiler and platform features.

I agree. Saying something to the effect of "passing sanitizer names to --sanitizers will enable them for the build. See your compiler documentation for what sanitizers are available". We should also mention that configure validates whether the options passed will build with the compiler in use.

@vpax
Copy link
Contributor Author

vpax commented Jan 8, 2024

We could provide links to fsanitize for GCC and clang if that's helpful?

Yes, something like that so it's clear where to start hunting. Right now it's fairly mysterious to someone coming to it afresh.

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

No branches or pull requests

3 participants