aboutsummaryrefslogtreecommitdiffstats
path: root/.gitlab-ci/tracie
diff options
context:
space:
mode:
authorAndres Gomez <[email protected]>2020-04-20 14:19:26 +0300
committerMarge Bot <[email protected]>2020-04-30 12:21:28 +0000
commit5e9ae4043004e5505f3c7e327d38911330c04dcb (patch)
tree37e20110a35e11133eb47ba37ebecd9229b410e7 /.gitlab-ci/tracie
parentbd86399db012d93e81d1a7734214ee8d52ad43ce (diff)
gitlab-ci: update tracie README after changes in main script
v2: - Update the default location for the traces when there is no traces-db entry in the traces definition file (Alexandros). Fixes: 90a39af5f65 "(ci: Drop the git dependency in tracie)" Signed-off-by: Andres Gomez <[email protected]> Reviewed-by: Alexandros Frantzis <[email protected]> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4640>
Diffstat (limited to '.gitlab-ci/tracie')
-rw-r--r--.gitlab-ci/tracie/README.md17
1 files changed, 6 insertions, 11 deletions
diff --git a/.gitlab-ci/tracie/README.md b/.gitlab-ci/tracie/README.md
index a459828982b..014bafc92e5 100644
--- a/.gitlab-ci/tracie/README.md
+++ b/.gitlab-ci/tracie/README.md
@@ -28,8 +28,8 @@ traces:
checksum: ff827f7eb069afd87cc305a422cba939
```
-The traces-db entry can be absent, in which case it is assumed that the
-current directory is the traces-db directory.
+The `traces-db` entry can be absent, in which case it is assumed that
+the traces can be found in the `CWD/traces-db` directory.
Traces that don't have an expectation for the current device are skipped
during trace replay.
@@ -99,22 +99,17 @@ publisher.
Mesa traces CI uses a set of scripts to replay traces and check the output
against reference checksums.
-The high level script [tracie.sh](.gitlab-ci/tracie/tracie.sh) accepts
-a traces definition file and the type of traces
-(apitrace/renderdoc/gfxreconstruct) to run:
+The high level script [tracie.py](.gitlab-ci/tracie/tracie.py) accepts
+a traces definition file and the name of the device to be tested:
- tracie.sh .gitlab-ci/traces.yml renderdoc
+ tracie.py --file .gitlab-ci/traces.yml --device-name gl-vmware-llvmpipe
-tracie.sh copies produced artifacts to the `$CI_PROJECT_DIR/result`
+tracie.py copies the produced artifacts to the `$CI_PROJECT_DIR/result`
directory. By default, created images from traces are only stored in case of a
checksum mismatch. The `TRACIE_STORE_IMAGES` CI/environment variable can be set
to `1` to force storing images, e.g., to get a complete set of reference
images.
-The `tracie.sh` script requires that the environment variable `DEVICE_NAME` is
-properly set for the target machine, and matches the `device` field of the
-relevant trace expectations in the used `traces.yml` file.
-
At a lower level the
[dump_trace_images.py](.gitlab-ci/tracie/dump_trace_images.py) script is
called, which replays a trace, dumping a set of images in the process. By