Add doc pointer for llvm-lit (#192)

tenstorrent · Jul 18, 2024 · 20c339c · 20c339c
1 parent a7d4923
commit 20c339c
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/src/build.md b/docs/src/build.md
@@ -58,6 +58,24 @@ source env/activate
 cmake --build build -- check-ttmlir
 ```
 
+### llvm-lit
+
+Under the hood the check-ttmlir cmake target is running `llvm-lit`. With it you
+can:
+
+```bash
+# Query which tests are available
+llvm-lit -sv ./build/test --show-tests
+
+# Run an individual test:
+llvm-lit -sv ./build/test/ttmlir/Dialect/TTIR/test_allocate.mlir
+
+# Run a sub-suite:
+llvm-lit -sv ./build/test/ttmlir/Dialect/TTIR
+```
+
+> See the full [llvm-lit documentation](https://llvm.org/docs/CommandGuide/lit.html) for more information.
+
 ## Lint
 
 ```bash