From 9238ef53ee4f1e324b30cb127cb81f9f0b3286aa Mon Sep 17 00:00:00 2001 From: Bert Peters Date: Mon, 23 May 2022 08:37:02 +0200 Subject: [PATCH 1/2] Update copyright --- LICENSE-APACHE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE-APACHE b/LICENSE-APACHE index 16fe87b..790581d 100644 --- a/LICENSE-APACHE +++ b/LICENSE-APACHE @@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work. same "printed page" as the copyright notice for easier identification within third-party archives. -Copyright [yyyy] [name of copyright owner] +Copyright 2022 Bert Peters Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. From 6afe7b1c4830f72198334066e91d64a74909b01e Mon Sep 17 00:00:00 2001 From: Bert Peters Date: Mon, 23 May 2022 08:53:56 +0200 Subject: [PATCH 2/2] Update README and CHANGELOG --- CHANGELOG.md | 5 ++++- README.md | 13 ++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5e1fd6f..15a5ab3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +## [0.2.1] - 2022-05-23 + ### Added - Build [docs.rs] documentation with all features enabled for completeness. @@ -65,7 +67,8 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Initial release. -[Unreleased]: https://github.com/bertptrs/tracing-mutex/compare/v0.2.0...HEAD +[Unreleased]: https://github.com/bertptrs/tracing-mutex/compare/v0.2.1...HEAD +[0.2.1]: https://github.com/bertptrs/tracing-mutex/compare/v0.2.0...v0.2.1 [0.2.0]: https://github.com/bertptrs/tracing-mutex/compare/v0.1.2...v0.2.0 [0.1.2]: https://github.com/bertptrs/tracing-mutex/compare/v0.1.1...v0.1.2 [0.1.1]: https://github.com/bertptrs/tracing-mutex/compare/v0.1.0...v0.1.1 diff --git a/README.md b/README.md index 60161df..4513fac 100644 --- a/README.md +++ b/README.md @@ -59,12 +59,23 @@ 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. +### Features + +- Dependency-tracking wrappers for all locking primitives +- Optional opt-out for release mode code +- Support for primitives from: + - `std::sync` + - `parking_lot` + - Any library that implements the `lock_api` traits + ## Future improvements - Improve performance in lock tracing - Optional logging to make debugging easier - Better and configurable error handling when detecting cyclic dependencies -- Support for other locking libraries, such as `parking_lot` +- Support for other locking libraries +- Support for async locking libraries +- Support for `Send` mutex guards **Note:** `parking_lot` has already began work on its own deadlock detection mechanism, which works in a different way. Both can be complimentary.