Skip to content

Commit

Permalink
Info in README about which OCaml version yto install.
Browse files Browse the repository at this point in the history
  • Loading branch information
lyrm committed Dec 4, 2024
1 parent d51f594 commit 8107790
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
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: 2 additions & 5 deletions src/saturn.mli
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Copyright (c) 2017, Nicolas ASSOUAD <[email protected]>
########
*)

(** Concurrent-safe data structures for Multicore OCaml. *)
(** Lock-free data structures for Multicore OCaml. *)

(** {1 Data structures} *)

Expand All @@ -41,10 +41,7 @@ module Single_prod_single_cons_queue = Spsc_queue
module Single_prod_single_cons_queue_unsafe = Spsc_queue_unsafe
module Single_consumer_queue = Mpsc_queue
module Skiplist = Skiplist
module Size = Size
module Htbl = Htbl
module Htbl_unsafe = Htbl_unsafe
module Bag = Bag

(** {1 Tools} *)

module Size = Size

0 comments on commit 8107790

Please sign in to comment.