Skip to content

Commit 7948b39

Browse files
[llvm][docs] Small improvements to llvm-test-suite doc (#139083)
* Mention earlier that the C++ compiler will be inferred from the C compiler setting. It does say this later, but a mention earlier will save people (aka me) from wondering why we don't set CMAKE_CXX_COMPILER. * Mention earlier the compile only TEST_SUITE_RUN_BENCHMARKS=OFF setting, as it's a common use case. We already say the consequences of doing that, but not actually how to enable it until later in the doc. * Reorder that text to make more sense. * Make it into a proper Sphinx note block.
1 parent 5ae2aed commit 7948b39

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

llvm/docs/TestSuiteGuide.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ Quickstart
4545
```
4646

4747
3. Create a build directory and use CMake to configure the suite. Use the
48-
`CMAKE_C_COMPILER` option to specify the compiler to test. Use a cache file
49-
to choose a typical build configuration:
48+
`CMAKE_C_COMPILER` option to specify the compiler to test (the C++ compiler
49+
will be inferred automatically from this). Use a cache file to choose a typical
50+
build configuration:
5051

5152
```bash
5253
% mkdir test-suite-build
@@ -85,9 +86,15 @@ MicroBenchmarks/XRay microbenchmarks, you need to add `compiler-rt` to your
8586
PASS: test-suite :: MultiSource/Applications/ALAC/encode/alacconvert-encode.test (2 of 474)
8687
...
8788
```
88-
**NOTE!** even in the case you only want to get the compile-time results(code size, llvm stats etc),
89-
you need to run the test with the above `llvm-lit` command. In that case, the *results.json* file will
90-
contain compile-time metrics.
89+
90+
```{note}
91+
Even when you only want compile-time results you still need to run the test
92+
with the above `llvm-lit` command. In this case, the `results.json` file will
93+
contain compile time metrics only (code size, llvm stats and so on).
94+
95+
This mode is enabled by settting `-DTEST_SUITE_RUN_BENCHMARKS=OFF`,
96+
more details [here](common_configuration_options).
97+
```
9198

9299
6. Show and compare result files (optional):
93100

@@ -202,6 +209,7 @@ benchmarks. CMake can print a list of them:
202209
% cmake -LAH
203210
```
204211

212+
(common_configuration_options)=
205213
### Common Configuration Options
206214

207215
- `CMAKE_C_FLAGS`

0 commit comments

Comments
 (0)