diff --git a/CHANGES.md b/CHANGES.md index abffd096b..1c12dcdb6 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,47 @@ +## v1.1 + +New features: + +- Add `Eio.Path.symlink` (@patricoferris #715, reviewed by @talex5). + +- Add `Eio.Pool.use ~never_block` (@SGrondin #657, reviewed by @talex5). + +- Add `Eio.Time.Timeout.sleep` (@talex5 #726). + +Documentation: + +- Add `examples/fs` showing how to walk a directory tree (@talex5 #730). + +- README: explain that `read_all` reads until shutdown (@talex5 #717, reported by @Wenke-D). + +- Use long dash in README title (@lucperkins #718). + +Linux backend: + +- Require Linux >= 5.15 (@talex5 #720, reviewed by @SGrondin and @avsm). + Removes a work-around that required checking whether every flow was a tty. + +- Don't call submit immediately before wait (@talex5 #728). + This is slightly faster and makes the traces clearer. + +- Don't record submit events when there's nothing to submit (@talex5 #729). + Makes the traces a bit clearer. + +- Split flow into its own file (@talex5 #727). + +POSIX backend: + +- Add `_BSD_SOURCE` flag to fix build on OpenBSD (@prgbln #722). + +- Fix sandboxed path resolution on OpenBSD (@jebrosen #723, reviewed by @talex5). + OpenBSD uses `ELOOP` when opening a symlink with `O_NOFOLLOW`. + +Build and test: + +- Benchmarks: record uname, Eio backend, and number of cores (@talex5 #719). + +- Update to MDX 2.4.1 for OCaml 5.2 (@talex5 #712). + ## v1.0 New features: diff --git a/README.md b/README.md index 2511b1e73..cce5024da 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Eio replaces existing concurrency libraries such as Lwt * [Motivation](#motivation) * [Eio packages](#eio-packages) -* [Getting OCaml 5.1](#getting-ocaml-51) +* [Getting OCaml](#getting-ocaml) * [Getting Eio](#getting-eio) * [Running Eio](#running-eio) * [Testing with Mocks](#testing-with-mocks) @@ -92,7 +92,7 @@ See [Awesome Multicore OCaml][] for links to work migrating other projects to Ei - [Eio_main][] selects an appropriate backend (e.g. `eio_linux` or `eio_posix`), depending on your platform. - [Eio_js][] allows Eio code to run in the browser, using `js_of_ocaml`. -## Getting OCaml 5.1 +## Getting OCaml You'll need OCaml 5.1.0 or later. You can either install it yourself or build the included [Dockerfile](./Dockerfile). @@ -104,7 +104,7 @@ To install it yourself: 2. Use opam to install OCaml: ``` - opam switch create 5.1.1 + opam switch create 5.2.0 ``` ## Getting Eio