Skip to content

Commit 6dcabbc

Browse files
committed
Add recommendation for release build for regression test
Add recommendation to use release build flag when compiling for regression tests to warn users before they wait too long for regression tests on non-release builds.
1 parent 95042b1 commit 6dcabbc

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

REGRESSION_TESTS.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
This document assumes you have already been able to build CPROVER on
2+
your chosen architecture. For details on building CPROVER see
3+
COMPILING.md.
4+
5+
Regression tests can be run using make or cmake. Your choice here
6+
should be the same as the compiling of the project itself. (See
7+
COMPILING.md for details of both make and cmake build processes.)
8+
9+
Note that running all regression tests can be slow when a non-
10+
release build of CPROVER is used. It is highly recommended to
11+
compile with `-DCMAKE_BUILD_TYPE=Release` before running
12+
regression tests.
13+
14+
# MAKE
15+
16+
This can be done by changing to the regression directory and
17+
simply running make as follows.
18+
```
19+
cd regression
20+
make
21+
```
22+
23+
# CMAKE
24+
25+
This can be done by changing to the directory you built the
26+
project in with cmake and running ctest as follows.
27+
```
28+
cd <build_dir>
29+
ctest . -V -L CORE
30+
```
31+
You can also specify a pattern of tests to run as follows.
32+
```
33+
ctest . -V -L CORE -R <pattern>
34+
```
35+
For example
36+
```
37+
ctest . -V -L CORE -R goto
38+
```
39+
that will run all CORE tests that include `goto` in their
40+
name.
41+

0 commit comments

Comments
 (0)