Tag module docs with their required features

This commit is contained in:
2022-05-07 17:43:45 +02:00
parent fcc64e2cef
commit d1417e0b0c
3 changed files with 14 additions and 2 deletions

View File

@@ -6,10 +6,15 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased] ## [Unreleased]
### Fixed ### Added
- Build [docs.rs] documentation with all features enabled for completeness. - 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] ## [0.2.0]
### Added ### Added

View File

@@ -14,6 +14,8 @@ repository = "https://github.com/bertptrs/tracing-mutex"
[package.metadata.docs.rs] [package.metadata.docs.rs]
# Build docs for all features so the documentation is more complete # Build docs for all features so the documentation is more complete
all-features = true all-features = true
# Set custom cfg so we can enable docs.rs magic
rustdoc-args = ["--cfg", "docsrs"]
[dependencies] [dependencies]
lazy_static = "1" lazy_static = "1"

View File

@@ -45,6 +45,7 @@
//! enabled, and to the underlying mutex when they're not. //! enabled, and to the underlying mutex when they're not.
//! //!
//! [paper]: https://whileydave.com/publications/pk07_jea/ //! [paper]: https://whileydave.com/publications/pk07_jea/
#![cfg_attr(docsrs, feature(doc_cfg))]
use std::cell::RefCell; use std::cell::RefCell;
use std::cell::UnsafeCell; use std::cell::UnsafeCell;
use std::fmt; use std::fmt;
@@ -61,16 +62,20 @@ use std::sync::PoisonError;
use lazy_static::lazy_static; use lazy_static::lazy_static;
#[cfg(feature = "lockapi")] #[cfg(feature = "lockapi")]
#[cfg_attr(docsrs, doc(cfg(feature = "lockapi")))]
pub use lock_api; pub use lock_api;
#[cfg(feature = "parkinglot")] #[cfg(feature = "parkinglot")]
#[cfg_attr(docsrs, doc(cfg(feature = "parkinglot")))]
pub use parking_lot; pub use parking_lot;
use crate::graph::DiGraph; use crate::graph::DiGraph;
mod graph; mod graph;
#[cfg(feature = "lockapi")] #[cfg(feature = "lockapi")]
#[cfg_attr(docsrs, doc(cfg(feature = "lockapi")))]
pub mod lockapi; pub mod lockapi;
#[cfg(feature = "lockapi")] #[cfg(feature = "parkinglot")]
#[cfg_attr(docsrs, doc(cfg(feature = "parkinglot")))]
pub mod parkinglot; pub mod parkinglot;
pub mod stdsync; pub mod stdsync;