[clang] [Sanitizer][Docs] Improve docs on building Asan (PR #68636)

[Aiden Grossman via cfe-commits]

boomanaiden154 wrote:

Updated in 68281947f7df4c7325b862857fbf3ed06d711f74.

https://github.com/llvm/llvm-project/pull/68636
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[clang] [Sanitizer][Docs] Improve docs on building Asan (PR #68636)

[Vitaly Buka via cfe-commits]

vitalybuka wrote:

> Sorry. I'll wait longer to merge next time. I'll push a fixup to address the 
> comment. Thanks for the comment/review!

No need to be sorry, it's my fault.
Thanks for improving documentation.


https://github.com/llvm/llvm-project/pull/68636
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[clang] [Sanitizer][Docs] Improve docs on building Asan (PR #68636)

[Aiden Grossman via cfe-commits]

boomanaiden154 wrote:

Sorry. I'll wait longer to merge next time. I'll push a fixup to address the 
comment. Thanks for the comment/review!

https://github.com/llvm/llvm-project/pull/68636
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[clang] [Sanitizer][Docs] Improve docs on building Asan (PR #68636)

[Vitaly Buka via cfe-commits]

vitalybuka wrote:

I am to late with comment, can you make it in the same style as 
https://llvm.org/docs/CMake.html

One line, and with $:
```
.. code-block:: console

  $  cmake -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang"  
-DLLVM_ENABLE_RUNTIMES="compiler-rt" path/to/llvm/source
```

https://github.com/llvm/llvm-project/pull/68636
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[clang] [Sanitizer][Docs] Improve docs on building Asan (PR #68636)

[Aiden Grossman via cfe-commits]

https://github.com/boomanaiden154 closed 
https://github.com/llvm/llvm-project/pull/68636
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[clang] [Sanitizer][Docs] Improve docs on building Asan (PR #68636)

[Vitaly Buka via cfe-commits]

https://github.com/vitalybuka approved this pull request.


https://github.com/llvm/llvm-project/pull/68636
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[clang] [Sanitizer][Docs] Improve docs on building Asan (PR #68636)

[via cfe-commits]

llvmbot wrote:




@llvm/pr-subscribers-clang


Changes

Currently the documentation for building Asan doesn't specify that compiler-rt 
needs to be built as well. In addition, there's no minimal example for the LLVM 
CMake configuration. This patch addresses both of these issues.

The lack of specification about building compiler-rt has shown up on Discourse 
(e.g., https://discourse.llvm.org/t/enabling-address-sanitizer/73940/2).

---
Full diff: https://github.com/llvm/llvm-project/pull/68636.diff


1 Files Affected:

- (modified) clang/docs/AddressSanitizer.rst (+10-1) 


``diff
diff --git a/clang/docs/AddressSanitizer.rst b/clang/docs/AddressSanitizer.rst
index 37f34cb0cc9936d..94ff3404cba6024 100644
--- a/clang/docs/AddressSanitizer.rst
+++ b/clang/docs/AddressSanitizer.rst
@@ -26,7 +26,16 @@ Typical slowdown introduced by AddressSanitizer is **2x**.
 How to build
 
 
-Build LLVM/Clang with `CMake `_.
+Build LLVM/Clang with `CMake ` 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
 =

``




https://github.com/llvm/llvm-project/pull/68636
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[clang] [Sanitizer][Docs] Improve docs on building Asan (PR #68636)

[Aiden Grossman via cfe-commits]

https://github.com/boomanaiden154 created 
https://github.com/llvm/llvm-project/pull/68636

Currently the documentation for building Asan doesn't specify that compiler-rt 
needs to be built as well. In addition, there's no minimal example for the LLVM 
CMake configuration. This patch addresses both of these issues.

The lack of specification about building compiler-rt has shown up on Discourse 
(e.g., https://discourse.llvm.org/t/enabling-address-sanitizer/73940/2).

>From 49d010d28ba10ba86c58e8cd71e9c5af35a7c9e7 Mon Sep 17 00:00:00 2001
From: Aiden Grossman 
Date: Mon, 9 Oct 2023 11:11:18 -0700
Subject: [PATCH] [Sanitizer][Docs] Improve docs on building Asan

Currently the documentation for building Asan doesn't specify that
compiler-rt needs to be built as well. In addition, there's no minimal
example for the LLVM CMake configuration. This patch addresses both of
these issues.
---
 clang/docs/AddressSanitizer.rst | 11 ++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/clang/docs/AddressSanitizer.rst b/clang/docs/AddressSanitizer.rst
index 37f34cb0cc9936d..94ff3404cba6024 100644
--- a/clang/docs/AddressSanitizer.rst
+++ b/clang/docs/AddressSanitizer.rst
@@ -26,7 +26,16 @@ Typical slowdown introduced by AddressSanitizer is **2x**.
 How to build
 
 
-Build LLVM/Clang with `CMake `_.
+Build LLVM/Clang with `CMake ` 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
 =

___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits