mirror of
https://github.com/bertptrs/tracing-mutex.git
synced 2025-12-25 20:50:32 +01:00
Tag module docs with their required features
This commit is contained in:
@@ -6,10 +6,15 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Fixed
|
||||
### Added
|
||||
|
||||
- Build [docs.rs] documentation with all features enabled for completeness.
|
||||
|
||||
### Fixed
|
||||
|
||||
- The `parkinglot` module is now correctly enabled by the `parkinglot` feature rather than the
|
||||
`lockapi` feature.
|
||||
|
||||
## [0.2.0]
|
||||
|
||||
### Added
|
||||
|
||||
@@ -14,6 +14,8 @@ repository = "https://github.com/bertptrs/tracing-mutex"
|
||||
[package.metadata.docs.rs]
|
||||
# Build docs for all features so the documentation is more complete
|
||||
all-features = true
|
||||
# Set custom cfg so we can enable docs.rs magic
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
|
||||
[dependencies]
|
||||
lazy_static = "1"
|
||||
|
||||
@@ -45,6 +45,7 @@
|
||||
//! enabled, and to the underlying mutex when they're not.
|
||||
//!
|
||||
//! [paper]: https://whileydave.com/publications/pk07_jea/
|
||||
#![cfg_attr(docsrs, feature(doc_cfg))]
|
||||
use std::cell::RefCell;
|
||||
use std::cell::UnsafeCell;
|
||||
use std::fmt;
|
||||
@@ -61,16 +62,20 @@ use std::sync::PoisonError;
|
||||
|
||||
use lazy_static::lazy_static;
|
||||
#[cfg(feature = "lockapi")]
|
||||
#[cfg_attr(docsrs, doc(cfg(feature = "lockapi")))]
|
||||
pub use lock_api;
|
||||
#[cfg(feature = "parkinglot")]
|
||||
#[cfg_attr(docsrs, doc(cfg(feature = "parkinglot")))]
|
||||
pub use parking_lot;
|
||||
|
||||
use crate::graph::DiGraph;
|
||||
|
||||
mod graph;
|
||||
#[cfg(feature = "lockapi")]
|
||||
#[cfg_attr(docsrs, doc(cfg(feature = "lockapi")))]
|
||||
pub mod lockapi;
|
||||
#[cfg(feature = "lockapi")]
|
||||
#[cfg(feature = "parkinglot")]
|
||||
#[cfg_attr(docsrs, doc(cfg(feature = "parkinglot")))]
|
||||
pub mod parkinglot;
|
||||
pub mod stdsync;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user