summaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorJosh Soref <2119212+jsoref@users.noreply.github.com>2024-09-26 04:40:15 -0400
committerGitHub <noreply@github.com>2024-09-26 08:40:15 +0000
commit7d2142be0a3c499c489588cce8ecf3bfc98f4859 (patch)
treeec01fe3f9a7637a6b50afbeca418fa6a6281ddbd /tests
parent30a301f8ff890bdd5ae41ed159e7669926ef6059 (diff)
Connect maximum size with Updating reference images (#5022)
Diffstat (limited to 'tests')
-rw-r--r--tests/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md
index e7713eed..d21784b6 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -87,6 +87,8 @@ There are, broadly speaking, three kinds of tests:
To prevent bloat, it is important that the test images are kept as small as
possible. To that effect, the test runner enforces a maximum size of 20 KiB.
+ If you're updating a test and hit `reference image size exceeds`, see
+ Updating reference images.
If truly necessary, this limit can however be lifted by adding `// LARGE` as
the first line of a test.
@@ -102,6 +104,9 @@ flag:
testit --exact my-test-name --update
```
+This will generally generate compressed reference images (to remain within the
+above size limit).
+
If you use the VS Code test helper extension (see the `tools` folder), you can
alternatively use the save button to update the reference image.