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: 90a39af5f6 "(ci: Drop the git dependency in tracie)"
Signed-off-by: Andres Gomez <agomez@igalia.com>
Reviewed-by: Alexandros Frantzis <alexandros.frantzis@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4640>
(cherry picked from commit 5e9ae40430)
This commit is contained in:
Andres Gomez 2020-04-20 14:19:26 +03:00 committed by Eric Engestrom
parent 4e710b3c37
commit 8c0ad1d2db
2 changed files with 7 additions and 12 deletions

View File

@ -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

View File

@ -1390,7 +1390,7 @@
"description": "gitlab-ci: update tracie README after changes in main script",
"nominated": true,
"nomination_type": 1,
"resolution": 0,
"resolution": 1,
"master_sha": null,
"because_sha": "90a39af5f65e5fa01beeec526594f7e04143e7cf"
},