From de9888a1020362939a446a78976819f243c59cac Mon Sep 17 00:00:00 2001 From: Bert Peters Date: Mon, 29 Aug 2022 08:32:17 +0200 Subject: [PATCH] Update documentation with MSRV --- CHANGELOG.md | 5 +++++ README.md | 7 ++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 538c4c8..55ef4b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,11 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Added + +- The minimum supported Rust version is now defined as 1.63. Previously it was undefined. +- Wrappers for `std::sync` primitives can now be `const` constructed. + ### Breaking - Update [`parking_lot`][parking_lot] dependency to `0.12`. diff --git a/README.md b/README.md index 99f2791..8210891 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,12 @@ tree out of it, and panics if your dependencies would create a cycle. It provide existing synchronization primitives with an identical API, and should be a drop-in replacement. Inspired by [this blogpost][whileydave], which references a similar behaviour implemented by -[Abseil][abseil-mutex] for their mutexes. +[Abseil][abseil-mutex] for their mutexes. [This article goes into more depth on the exact +implementation.][article] [whileydave]: https://whileydave.com/2020/12/19/dynamic-cycle-detection-for-lock-ordering/ [abseil-mutex]: https://abseil.io/docs/cpp/guides/synchronization +[article]: https://bertptrs.nl/2022/06/23/deadlock-free-mutexes-and-directed-acyclic-graphs.html ## Usage @@ -59,6 +61,9 @@ performance penalty in your production environment, this library also offers deb when debug assertions are enabled, and to `Mutex` when they are not. Similar helper types are available for other synchronization primitives. +The minimum supported Rust version is 1.63. Increasing this is not considered a breaking change, but +will be avoided within semver-compatible releases if possible. + ### Features - Dependency-tracking wrappers for all locking primitives