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

[via llvm-commits]

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

None

>From 7f71a3ce0b7fe5e40e5bf731a9ee7b5b74f06ac4 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 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/llvm/docs/TestSuiteGuide.md b/llvm/docs/TestSuiteGuide.md
index 85623da080ed8..ce018d8002187 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):
 
@@ -266,7 +269,7 @@ Example usage:
 
   ```bash
   % test-suite/utils/compare.py -m compile_time baseline.json
-  % test-suite/utils/compare.py -m size.__text baseline.json
+  % test-suite/utils/compare.py -m size..text baseline.json
   ```
 
 - Compare two result files and filter short running tests: