mirror of
https://github.com/bertptrs/tracing-mutex.git
synced 2025-12-25 20:50:32 +01:00
Document new functionality
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
//! Utilities related to the internals of dependency tracking.
|
||||
use crate::MutexId;
|
||||
|
||||
/// Reset the dependencies for the given entity.
|
||||
|
||||
Reference in New Issue
Block a user