Skip to content

Commit

Permalink
[Sanitizer][Docs] Improve docs on building Asan (#68636)
Browse files Browse the repository at this point in the history
  • Loading branch information
boomanaiden154 committed Oct 9, 2023
1 parent 3684f6a commit 115b6a3
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion clang/docs/AddressSanitizer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,16 @@ Typical slowdown introduced by AddressSanitizer is **2x**.
How to build
============

Build LLVM/Clang with `CMake <https://llvm.org/docs/CMake.html>`_.
Build LLVM/Clang with `CMake <https://llvm.org/docs/CMake.html>` and enable
the ``compiler-rt`` runtime. An example CMake configuration that will allow
for the use/testing of AddressSanitizer:

.. code-block:: console
cmake -DCMAKE_BUILD_TYPE=Release \
-DLLVM_ENABLE_PROJECTS="clang" \
-DLLVM_ENABLE_RUNTIMES="compiler-rt" \
../llvm
Usage
=====
Expand Down

0 comments on commit 115b6a3

Please sign in to comment.