summaryrefslogtreecommitdiffstats
path: root/tests/coverage-map/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--tests/coverage-map/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/tests/coverage-map/README.md b/tests/coverage-map/README.md
new file mode 100644
index 000000000..60d1352cd
--- /dev/null
+++ b/tests/coverage-map/README.md
@@ -0,0 +1,13 @@
+The tests in `./status-quo` were copied from `tests/run-coverage` in order to
+capture the current behavior of the instrumentor on non-trivial programs.
+The actual mappings have not been closely inspected.
+
+## Maintenance note
+
+These tests can be sensitive to small changes in MIR spans or MIR control flow,
+especially in HIR-to-MIR lowering or MIR optimizations.
+
+If you haven't touched the coverage code directly, and the `run-coverage` test
+suite still works, then it should usually be OK to just `--bless` these
+coverage mapping tests as necessary, without worrying too much about the exact
+changes.