Skip to content

Commit 7b27da8

Browse files
authored
Add more detailed test and benchmark instructions (#943)
1 parent 7ffc276 commit 7b27da8

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,35 @@ the `containers` package.
2222

2323
Minimum cabal version: 2.4
2424

25+
Build:
2526
```
2627
cabal build containers
27-
cabal test containers-test
28-
cabal bench containers-test
28+
```
29+
30+
Run all tests or benchmarks:
31+
```
32+
cabal test containers-tests
33+
cabal bench containers-tests
34+
```
35+
36+
To run a particular test or benchmark suite, name the target from
37+
`containers-tests/containers-tests.cabal`:
38+
```
39+
cabal run set-properties # cabal test also works
40+
cabal run map-benchmarks # cabal bench also works
41+
```
42+
43+
To run selective tests or benchmarks, you can pass a
44+
[filter pattern](https://hackage.haskell.org/package/tasty#patterns) as
45+
supported by `tasty`:
46+
```
47+
cabal run set-properties -- -p fromList
48+
cabal test set-properties --test-options "-p fromList"
2949
```
3050

3151
#### For Windows users
3252

33-
To compile `containers-test`, you need symbolic links to be activated on git.
53+
To compile `containers-tests`, you need symbolic links to be activated on git.
3454
To do so on Windows 10 or higher, follow these steps:
3555

3656
1. Activate developer mode in your Windows preferences.

0 commit comments

Comments
 (0)