summaryrefslogtreecommitdiff
path: root/test/regress/README.md
diff options
context:
space:
mode:
authorAndres Noetzli <andres.noetzli@gmail.com>2018-06-04 10:56:19 -0700
committerGitHub <noreply@github.com>2018-06-04 10:56:19 -0700
commit8b7a4af93226b2ecb82814a7609855deea0230cd (patch)
tree92fe6135042046203cff69467e51a23222c11b3b /test/regress/README.md
parent6de92e6a6ac4dd81ff7f65bf33bddfabfc3e2c48 (diff)
Regressions: Support for requiring CVC4 features (#2044)
This commit adds supprt for the `REQUIRES` directive in our regression benchmarks. This directive can be used to enable certain benchmarks only if CVC4 has been configured with certain features enabled.
Diffstat (limited to 'test/regress/README.md')
-rw-r--r--test/regress/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/test/regress/README.md b/test/regress/README.md
index f6ff3c68b..d0c9b2b7a 100644
--- a/test/regress/README.md
+++ b/test/regress/README.md
@@ -108,6 +108,19 @@ string `TERM` to make the regression test robust to the actual term printed
(e.g. there could be multiple non-linear facts and it is ok if any of them is
printed).
+Sometimes, certain benchmarks only apply to certain CVC4
+configurations. The `REQUIRES` directive can be used to only run
+a given benchmark when a feature is supported. For example:
+
+```
+; REQUIRES: symfpu
+```
+
+This benchmark is only run when symfpu has been configured.
+Multiple `REQUIRES` directives are supported. For a list of
+features that can be listed as a requirement, refer to CVC4's
+`--show-config` output.
+
Sometimes it is useful to keep the directives separate. You can separate the
benchmark from the output expectations by putting the benchmark in `<benchmark
file>.smt` and the directives in `<benchmark file>.smt.expect`, which is looked
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback