[PATCH] D101467: [docs] Add the compiler-rt requirement to the test suite doc

[Mircea Trofin via Phabricator via llvm-commits]

mtrofin created this revision.
mtrofin added reviewers: MaskRay, dblaikie.
Herald added a subscriber: dberris.
mtrofin requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D101467

Files:
  llvm/docs/TestSuiteGuide.md


Index: llvm/docs/TestSuiteGuide.md
===================================================================
--- llvm/docs/TestSuiteGuide.md
+++ llvm/docs/TestSuiteGuide.md
@@ -42,6 +42,10 @@
            ../test-suite
    ```
 
+**NOTE!** if you are using your built clang, you need to have had also enabled
+`compiler-rt`, otherwise the XRay microbenchmarks will fail to compile. Make
+sure you add `compiler-rt` to your `LLVM_ENABLE_PROJECTS` cmake flag.
+
 4. Build the benchmarks:
 
    ```text


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D101467.341233.patch
Type: text/x-patch
Size: 493 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210428/e49704d8/attachment.bin>