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

[via llvm-commits]

Author: AdityaK
Date: 2024-06-10T10:11:49-07:00
New Revision: caf2de76e4c3ec70e012bc2582349d34ec6018fc

URL: https://github.com/llvm/llvm-project/commit/caf2de76e4c3ec70e012bc2582349d34ec6018fc
DIFF: https://github.com/llvm/llvm-project/commit/caf2de76e4c3ec70e012bc2582349d34ec6018fc.diff

LOG: Document that llvm-lit needs to be run to collect static metrics (#94836)

Added: 
    

Modified: 
    llvm/docs/TestSuiteGuide.md

Removed: 
    


################################################################################
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):