Skip to content

Commit acd1e03

Browse files
committed
docs: more tweaking of the gold-file instructions
1 parent b8498bf commit acd1e03

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

tests/gold/README.rst

+19-5
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,22 @@ current output of the tests into the gold files. When a test fails, the actual
1212
output is in the tests/actual directory. Those files are ignored by git.
1313

1414
There's a Makefile in the html directory for working with gold files and their
15-
associated support files. If actual outputs have changed so that comparisons
16-
are failing, but the new output is correct, you can use "make update-gold" to
17-
copy the actual output as the new gold files.
15+
associated support files.
16+
17+
To view the tests/actual files, you need to tentatively copy them to the gold
18+
directories, and then add the supporting files so they can be viewed as
19+
complete output. For example::
20+
21+
cp tests/actual/html/contexts/* tests/gold/html/contexts
22+
cd tests/actual/html
23+
make complete
24+
25+
If the new actual output is correct, you can use "make update-gold" to copy the
26+
actual output as the new gold files.
27+
28+
If you have changed some of the supporting files (.css or .js), then "make
29+
update-support" will copy the updated files to the tests/gold/html/support
30+
directory for checking test output.
1831

1932
If you have added a gold test, you'll need to manually copy the tests/actual
2033
files to tests/gold.
@@ -27,8 +40,9 @@ again, you can run just the failed tests again with::
2740
The saved HTML files in the html directories can't be viewed properly without
2841
the supporting CSS and Javascript files. But we don't want to save copies of
2942
those files in every subdirectory. The make target "make complete" in
30-
tests/gold/html will copy the support file so you can open the HTML files to
31-
see how they look.
43+
tests/gold/html will copy the support files so you can open the HTML files to
44+
see how they look. When you are done checking the output, you can use "make
45+
clean" to remove the support files from the gold directories.
3246

3347
If the output files are correct, you can update the gold files with "make
3448
update-gold". If there are version-specific gold files (for example,

0 commit comments

Comments
 (0)