Add Sanitizers documentation

[uilianries]

Related to conan-io/examples2#192

This is a new documentation page and spiritual successor of https://docs.conan.io/1/howtos/sanitizers.html

Also related to Conan issues:

• Defining custom settings.yml for sanitizers conan#13981
• [question] Sanitizers in conan packages conan#17797
• [question] How to add compiler sanitisers to conan conan#15374

Close conan-io/conan#19191

[czoido]

I think it would be good, before this section, to add a bit of explanation about how sanitizers influence binary compatibility and then, as a result, explain how you can model it for these cases.

Also, it would be great to do some research about if all the sanitizers will make binaries to break compatibility or there are cases were you can apply the sanitizers just as flags without the risk of producing incompatible binaries.

[uilianries]

I've added an explanation about what each sanitizers does in the library/application and their abi compatibility as well. Please, review it again.

[czoido]

I’d suggest restructuring the page so readers get the why/what before the how. Right now the doc asks to clone the repo in the middle of conceptual explanations, which interrupts the flow. It would be clearer to start with the important concepts and only then move to the hands-on example.

Depending on how extensive we want the theoretical part to be, we might even split it out into a separate page (so this page stays more tutorial-oriented, and the other more reference-style).

[uilianries]

I moved to the end of the document:

Present everything about Sanitizers -> How to configure Sanitizer with Conan -> Example -> Final considerations.

[czoido]

I think it would be good to talk about the difference in sanitizer support for each compiler, maybe do a comparative table or something like that?

[uilianries]

This would be huge, considering the number of sanitizers supported by llvm. I pointed the sanitizers pages as a link in the documentation.

Let me add a table, in case it gets too big, we can still summarize to most important sanitizers.

[czoido]

It's just for consideration, if you think that it would add value...

[uilianries]

Just added some tables, indeed it is much clearer and visible now. Thank you for that suggestion! Please, take a look.

[uilianries]

@czoido @memsharded Hello! Thank you for another round of review. I just addressed your comments in my last commits. You can take a quick preview of how the documentation is on the commit 74acf05 here:

[memsharded]

Looking good, some further minor comments

[memsharded]

For discoverability, search purposes, something like C, C++ compiler sanitizers or something in that line, a bit more complete, could be nice

[uilianries]

Title updated by cd416bf

[memsharded]

This can be a bit confusing/not reproducible? Is this a gcc based or a clang profile?
Because the settings_user.yml above only added the sanitizer model to clang, not gcc, but the default profile in Linux systems is generally gcc.

Maybe it is better to fully explicitly define the profile? Or if not, maybe a comment saying the default profile is a clang one?

[uilianries]

Fixed by 0779b86

[memsharded]

Same here, at least a note that this is compiler=msvc and not others.

[uilianries]

Fixed by 25403f6

[memsharded]

Why this profile is here ~/.conan/profiles/asan and the previous one is compiler_sanitizers/profiles/asan? That is a big confusing, also both are named the same which seems pretty conflicting, maybe one should be msvc_asan and the other clang_asan in the name?

[uilianries]

Fixed by commit d239adc

[memsharded]

Maybe the section can be kept, but it would be necessary to at least clearly clarify that it only works when all dependencies are using CMake as build system and CMakeToolchain integration, it will not work for dependencies with Meson, autotools or others.

[memsharded]

Seems this extra intermediate level adds little.
Is there any other potential or future nested level under sanitizers that is not compiler_sanitizers?

[uilianries]

Moved to sanitizer folder by the commit d596bc2

[uilianries]

Maybe the section can be kept, but it would be necessary to at least clearly clarify that it only works when all dependencies are using CMake as build system and CMakeToolchain integration, it will not work for dependencies with Meson, autotools or others.

Added a note on the commit 763e8e3 to make it explicit

[uilianries]

Current preview based on the commit 763e8e3:

[memsharded]

Good for me, just a note about clang compiler profiles in Linux

[memsharded]

How this profile really uses clang in Linux? Isn't it necessary to at least define CC/CXX env-vars or compiler_executables confs?

[uilianries]

Good question. It's fine keeping gcc for these few examples, as it covers asan and ubsan.

I updated the settings_user as well on the commit 2decba9

[memsharded]

Same as above, this might use gcc compiler instead, the default one.

[uilianries]

Updated on the commit c5544ce

[memsharded]

Same as above

[uilianries]

Updated on the commit c5544ce4