Skip to content
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.

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

Fix deps and update deps for backoff and qcheck-stm libs #175

Merged
merged 4 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ jobs:
fail-fast: false
matrix:
ocaml-compiler:
- ocaml.5.0.0,ocaml-option-mingw
- ocaml.5.1.1,ocaml-option-mingw
- ocaml.5.2.0,ocaml-option-mingw

runs-on: windows-latest
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You can learn more about the **motivation** behind `Saturn` through the implemen
- [Saturn — Parallelism-Safe Data Structures for Multicore OCaml](#saturn--parallelism-safe-data-structures-for-multicore-ocaml)
- [Contents](#contents)
- [Installation](#installation)
- [Getting OCaml 5.0](#getting-ocaml-50)
- [Getting OCaml 5.2.0](#getting-ocaml-520)
- [Getting Saturn](#getting-saturn)
- [Provided data structures](#provided-data-structures)
- [Treiber Lock-free Stack](#treiber-lock-free-stack)
Expand All @@ -50,11 +50,11 @@ You can learn more about the **motivation** behind `Saturn` through the implemen

# Installation

## Getting OCaml 5.0
## Getting OCaml 5.2.0

You’ll need OCaml 5.0.0 or later. Note that Saturn also works with OCaml 4.14, but only for compatibility reasons, as parallelism-safe data structures are not needed without OCaml 5.0. We also recommend using OCaml 5.2 or later, as some bugs in the `Atomic` module have been fixed.
To use Saturn, you need OCaml 5.2.0 or later. While Saturn is compatible with OCaml 4.14, this is primarily for compatibility purposes, as parallelism-safe data structures are not required without OCaml 5. Note that versions of OCaml 5 prior to 5.2 are not supported due to bugs in the `Atomic` module that affect the functionality of some data structures.

To install OCaml 5.0 yourself, first make sure you have opam 2.1 or later. You
To install OCaml 5.2.0 yourself, first make sure you have opam 2.1 or later. You
can run this command to check:

```sh
Expand Down
7 changes: 4 additions & 3 deletions dune-project
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
(name saturn)
(synopsis "Collection of concurent-safe data structures for Multicore OCaml")
(depends
(ocaml (>= 4.14))
(backoff (>= 0.1.0))
(ocaml (or (and (>= 4.14) (< 5.0.0)) (>= 5.2.0)))
(backoff (>= 0.1.1))
(multicore-magic (>= 2.3.0))
(alcotest (and (>= 1.7.0) :with-test))
(domain_shims (and (>= 0.1.0) :with-test))
Expand All @@ -25,7 +25,8 @@
(qcheck (and (>= 0.21.3) :with-test))
(qcheck-alcotest (and (>= 0.21.3) :with-test))
(qcheck-core (and (>= 0.21.3) :with-test))
(qcheck-stm (and (>= 0.3) :with-test))
(qcheck-stm (and (>= 0.4) :with-test))
(qcheck-multicoretests-util (and (>= 0.4) :with-test))
(yojson (and (>= 2.0.2) :with-test))
(sherlodoc (and (>= 0.2) :with-doc))
(odoc (and (>= 2.4.1) :with-doc))))
7 changes: 4 additions & 3 deletions saturn.opam
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ doc: "https://ocaml-multicore.github.io/saturn/"
bug-reports: "https://github.com/ocaml-multicore/saturn/issues"
depends: [
"dune" {>= "3.14"}
"ocaml" {>= "4.14"}
"backoff" {>= "0.1.0"}
"ocaml" {>= "4.14" & < "5.0.0" | >= "5.2.0"}
"backoff" {>= "0.1.1"}
"multicore-magic" {>= "2.3.0"}
"alcotest" {>= "1.7.0" & with-test}
"domain_shims" {>= "0.1.0" & with-test}
Expand All @@ -21,7 +21,8 @@ depends: [
"qcheck" {>= "0.21.3" & with-test}
"qcheck-alcotest" {>= "0.21.3" & with-test}
"qcheck-core" {>= "0.21.3" & with-test}
"qcheck-stm" {>= "0.3" & with-test}
"qcheck-stm" {>= "0.4" & with-test}
"qcheck-multicoretests-util" {>= "0.4" & with-test}
"yojson" {>= "2.0.2" & with-test}
"sherlodoc" {>= "0.2" & with-doc}
"odoc" {>= "2.4.1" & with-doc}
Expand Down