[llvm] Document that llvm-lit needs to be run to collect static metrics (PR #94836)

via llvm-commits llvm-commits at lists.llvm.org
Sat Jun 8 08:20:03 PDT 2024


https://github.com/hiraditya updated https://github.com/llvm/llvm-project/pull/94836

>From b71add4e8cd09c779ea8fce2bfbdd7f09a5184ff Mon Sep 17 00:00:00 2001
From: AdityaK <hiraditya at msn.com>
Date: Fri, 7 Jun 2024 21:00:26 -0700
Subject: [PATCH] Document that llvm-lit needs to be run to collect static
 metrics

---
 llvm/docs/TestSuiteGuide.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/llvm/docs/TestSuiteGuide.md b/llvm/docs/TestSuiteGuide.md
index 85623da080ed8..9d43e1a345ffe 100644
--- a/llvm/docs/TestSuiteGuide.md
+++ b/llvm/docs/TestSuiteGuide.md
@@ -71,6 +71,9 @@ MicroBenchmarks/XRay microbenchmarks, you need to add `compiler-rt` to your
    PASS: test-suite :: MultiSource/Applications/ALAC/encode/alacconvert-encode.test (2 of 474)
    ...
    ```
+**NOTE!** even in the case you only want to get the compile-time results(code size, llvm stats etc),
+you need to run the test with the above `llvm-lit` command. In that case, the *results.json* file will
+contain compile-time metrics.
 
 6. Show and compare result files (optional):
 



More information about the llvm-commits mailing list