From 8107790ea9171830507fb7c75f12efc7f8f3f5d9 Mon Sep 17 00:00:00 2001 From: Carine Morel Date: Wed, 4 Dec 2024 15:02:53 +0100 Subject: [PATCH] Info in README about which OCaml version yto install. --- README.md | 8 ++++---- src/saturn.mli | 7 ++----- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 69a9cae8..9f41f5a3 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 diff --git a/src/saturn.mli b/src/saturn.mli index f084cc04..18fe14cf 100644 --- a/src/saturn.mli +++ b/src/saturn.mli @@ -26,7 +26,7 @@ Copyright (c) 2017, Nicolas ASSOUAD ######## *) -(** Concurrent-safe data structures for Multicore OCaml. *) +(** Lock-free data structures for Multicore OCaml. *) (** {1 Data structures} *) @@ -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