From 3be9e5b6afae453b1451349f407c3dac85b3cf69 Mon Sep 17 00:00:00 2001 From: trillian Date: Mon, 31 Jul 2023 02:39:33 +0300 Subject: [PATCH] document more of the test file format in readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7936f3ad..23e73b1d 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ These two characters should precede each test line, so that Asar sees them as co * 2 hex digits - a byte for it to check for * You can specify more than one, like in the examples below, and it will automatically increment the offset. * A line starting with `+` tells the testing app to patch the SMW ROM instead of creating a new ROM +* `#{num}` tells the testing app to apply the patch `{num}` times to the same file * `errE{name}` and `warnW{name}` (where `{name}` is the name of an error or warning) means that the test is expected to throw that specific error or warning while patching. The test will succeed only if the number and order of errors and warnings thrown exactly matches what's specified here. Be wary that Asar uses multiple passes and throws errors and warnings across multiple of them. This can make the actual order in which errors and warnings are thrown a bit unintuitive. In addition to the format mentioned above, it's also possible to check for user prints a patch is expected to output (by `print`, `error`, `warn` or `assert` commands). This is done by starting the line with one of the following sequences: