summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Turner <mattst88@gmail.com>2023-09-06 15:34:29 -0400
committerMatt Turner <mattst88@gmail.com>2023-09-06 16:41:05 -0400
commit9ebf7c93103266d6a648543e00cc1b26213efc83 (patch)
treeac06dc5dd68bf7fd0026fdb7019eb44261bba022
parent79961368987a130a9e185a400f0c83792d6fff79 (diff)
README.md: Add
-rw-r--r--README.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..94db353
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# mesa-run
+
+A collection of scripts to build and test [Mesa](https://www.mesa3d.org/) without installing it.
+
+## Scripts
+
+- [nj](nj) - Run [ninja](https://github.com/ninja-build/ninja) from anywhere in the project git repository
+- [mesa-run](mesa-run) - helper script. Not used directly. Requires [jq](https://github.com/jqlang/jq)
+- [mesa-debug](mesa-debug) - Debug build
+- [mesa-debug-asan](mesa-debug-asan) - Debug build with [AddressSanitizer](https://github.com/google/sanitizers/wiki/AddressSanitizer)
+- [mesa-debug-optimized](mesa-debug-optimized) - Debug build with optimization
+- [mesa-release](mesa-release) - Release build
+- [mesa-gdb](mesa-gdb) - Wrapper around `mesa-debug` that invokes `gdb`
+- [deqp-run](deqp-run) - Run dEQP test suites
+- [deqp-results-to-markdown](deqp-results-to-markdown) - Generate Markdown table of dEQP test suite results
+
+## Examples
+
+### Configure and build debug build
+
+```sh
+mesa-debug configure
+nj debug install
+```
+
+### Run program with local Mesa build
+
+```sh
+mesa-debug glxinfo
+```
+
+### Run dEQP
+
+On ChromeOS, `deqp-run` uses the system-provided `media-gfx/deqp` package. The script should be run from a directory that has space to store the output such as `/mnt/stateful_partition/home/root/`.
+
+On desktop Linux, `deqp-run` should be run from a git checkout of [VK-GL-CTS](https://github.com/KhronosGroup/VK-GL-CTS/) with a build configured with `-DDEQP_TARGET=surfaceless` in `build/`.
+
+#### Single test
+
+```sh
+deqp-run dEQP-VK.graphicsfuzz.spv-stable-pillars-volatile-nontemporal-store
+```
+
+#### Test suite
+
+```sh
+deqp-run vk
+```
+
+### Make Markdown table of dEQP test results
+
+```sh
+deqp-results-to-markdown
+```
+
+#### Example output
+
+| | Pass | Fail | Skip | Warn | Timeout | Flake |
+| ---------------- | ---: | ---: | ---: | ---: | ------: | ----: |
+| **dEQP-GLES2** |14243| |26| | | |
+| **dEQP-GLES3** |42687| |113|2| | |
+| **dEQP-GLES31** |37576| |55| | | |
+| **dEQP-VK** |486602|2|590787|6|2|1|