From 8c1aa693f718414bba8cd1400d2b49ff39eeb828 Mon Sep 17 00:00:00 2001 From: Jasper Hugunin Date: Sat, 6 Jan 2018 21:40:02 +0900 Subject: First stab at documenting the test suite. --- test-suite/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 test-suite/README.md (limited to 'test-suite/README.md') diff --git a/test-suite/README.md b/test-suite/README.md new file mode 100644 index 000000000..30a71ed87 --- /dev/null +++ b/test-suite/README.md @@ -0,0 +1,17 @@ +# Coq Test Suite + +The test suite can be run from the root directory by `make test-suite`. + +From this directory, `make aaa/bbb/ccc.v.log` runs one test (if not already run), storing the output in the named `.log` file. +See [`test-suite/Makefile`](/test-suite/Makefile) for more information. + +## Adding a test + +Regression tests for closed bugs should be added to `test-suite/bugs/closed`, as `1234.v` where `1234` is the bug number. +Files in this directory are tested for successful compilation. +When you fix a bug, you should usually add a regression test here as well. + +The error "(bug seems to be opened, please check)" when running `make test-suite` means that a test in `bugs/closed` failed to compile. + +There are also output tests in `test-suite/output` which consist of a `.v` file and a `.out` file with the expected output. + -- cgit v1.2.3