diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b9472c..c13dc62 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,14 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). `tracing_mutex::parkinglot` is now identical to `parking_lot`, and an example showing how to use it as a drop-in replacement was added. +- Introduced `experimental` feature, which will be used going forward to help evolve the API outside + the normal stability guarantees. APIs under this feature are not subject to semver or MSRV + guarantees. + +- Added experimental api `tracing_mutex::util::reset_dependencies`, which can be used to reset the + ordering information of a specific mutex when you need to reorder them. This API is unsafe, as its + use invalidates any of the deadlock prevention guarantees made. + ### Changed - Reworked CI to better test continued support for the minimum supported Rust version diff --git a/src/lib.rs b/src/lib.rs index 3bb51ce..6a446ea 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -30,12 +30,17 @@ //! //! - `backtraces`: Enables capturing backtraces of mutex dependencies, to make it easier to //! determine what sequence of events would trigger a deadlock. This is enabled by default, but if -//! the performance overhead is unaccceptable, it can be disabled by disabling default features. +//! the performance overhead is unacceptable, it can be disabled by disabling default features. //! //! - `lockapi`: Enables the wrapper lock for [`lock_api`][lock_api] locks //! //! - `parkinglot`: Enables wrapper types for [`parking_lot`][parking_lot] mutexes //! +//! - `experimental`: Enables experimental features. Experimental features are intended to test new +//! APIs and play with new APIs before committing to them. As such, breaking changes may be +//! introduced in it between otherwise semver-compatible versions, and the MSRV does not apply to +//! experimental features. +//! //! # Performance considerations //! //! Tracing a mutex adds overhead to certain mutex operations in order to do the required diff --git a/src/util.rs b/src/util.rs index f4ea6a3..a382802 100644 --- a/src/util.rs +++ b/src/util.rs @@ -1,3 +1,4 @@ +//! Utilities related to the internals of dependency tracking. use crate::MutexId; /// Reset the dependencies for the given entity.