Skip to content

Clarify test suite recommendations in README #545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 28, 2025
Merged

Clarify test suite recommendations in README #545

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6c47dbf
Bump 5.0.0 to 5.3.0
jmid Mar 28, 2025
189b822
Clarify the need for multiple CPUs and recommend at least 3
jmid Mar 28, 2025
51113d8
Add explicit -j1 recommendation
jmid Mar 28, 2025
5f05049
Tone down maintenance
jmid Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,14 @@ Installation instructions, and running the tests
The multicore test suite requires OCaml 5.x:
```
opam update
opam switch create 5.0.0
opam switch create 5.3.0
```

It is designed to stress test OCaml 5's multicore features. As such, it requires
a multicore machine to run successfully and will fail on a single-CPU setup. We
recommend running the test suite with 3 or more (virtual) CPUs.


Installing the libraries
------------------------

Expand Down Expand Up @@ -110,6 +115,11 @@ dune build
dune runtest -j1 --no-buffer --display=quiet
```

As some of the tests are negative, e.g., confirming known domain unsafety by
finding a counterexample, we recommend running only one property-based test at a
time (`-j1`) to prevent contention between the individual tests for CPU
resources.

Individual tests can be run by invoking `dune exec`. For example:
```
$ dune exec src/atomic/stm_tests.exe -- -v
Expand Down Expand Up @@ -830,4 +840,4 @@ let () = Task.teardown_pool pool

---

This project has been created and is maintained by <a href="https://tarides.com/">Tarides</a>.
This project has been created by <a href="https://tarides.com/">Tarides</a>.
Loading