Skip to content

Commit

Permalink
Update documentation with MSRV
Browse files Browse the repository at this point in the history
  • Loading branch information
bertptrs committed Aug 29, 2022
1 parent 2d2e03e commit de9888a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit de9888a

Please sign in to comment.