Merge #130

130: Clarify docs regarding parking_lot r=matklad a=matklad

bors r+
🤖

Co-authored-by: Aleksey Kladov <[email protected]>

Cargo.toml

@@ -21,7 +21,7 @@ members = ["xtask"]
 [dependencies]
 # Uses parking_lot to implement once_cell::sync::OnceCell.
 # This makes not speed difference, but makes each OnceCell<T>
-# for up to two bytes smaller, depending on the size of the T.
+# for up to 16 bytes smaller, depending on the size of the T.
 parking_lot = { version = "0.11", optional = true, default_features = false }
 
 [dev-dependencies]

src/imp_std.rs

@@ -253,6 +253,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg(not(miri))]
     fn stampede_once() {
         static O: OnceCell<()> = OnceCell::new();
         static mut RUN: bool = false;

src/lib.rs

@@ -233,10 +233,11 @@
 //! and [`lazy_cell`](https://github.com/indiv0/lazycell/) crates and [`std::sync::Once`]. In some sense,
 //! `once_cell` just streamlines and unifies those APIs.
 //!
-//! To implement a sync flavor of `OnceCell`, this crates uses either a custom re-implementation of
-//! `std::sync::Once` or `parking_lot::Mutex`. This is controlled by the `parking_lot` feature, which
-//! is enabled by default. Performance is the same for both cases, but the `parking_lot` based `OnceCell<T>`
-//! is smaller by up to 16 bytes.
+//! To implement a sync flavor of `OnceCell`, this crates uses either a custom
+//! re-implementation of `std::sync::Once` or `parking_lot::Mutex`. This is
+//! controlled by the `parking_lot` feature (disabled by default). Performance
+//! is the same for both cases, but the `parking_lot` based `OnceCell<T>` is
+//! smaller by up to 16 bytes.
 //!
 //! This crate uses `unsafe`.
 //!