From 8b642b9804d36db4f6a2a226ff7870e464e71b90 Mon Sep 17 00:00:00 2001 From: Taiki Endo Date: Sat, 23 Nov 2024 03:01:47 +0900 Subject: [PATCH] util: Update docs and changelog --- portable-atomic-util/CHANGELOG.md | 4 +++- portable-atomic-util/README.md | 11 +++++++---- portable-atomic-util/src/lib.rs | 11 +++++++---- 3 files changed, 17 insertions(+), 9 deletions(-) diff --git a/portable-atomic-util/CHANGELOG.md b/portable-atomic-util/CHANGELOG.md index c835f2fb..bc8f557e 100644 --- a/portable-atomic-util/CHANGELOG.md +++ b/portable-atomic-util/CHANGELOG.md @@ -12,7 +12,9 @@ Note: In this file, do not use the hard wrap in the middle of a sentence for com ## [Unreleased] -- Add `portable_atomic_unstable_coerce_unsized` cfg option (requires Rust nightly) +- Add unstable `portable_atomic_unstable_coerce_unsized` cfg (requires Rust nightly). ([#195](https://github.com/taiki-e/portable-atomic/pull/195), thanks @brodycj) + +- Respect [`RUSTC_BOOTSTRAP=-1` recently added in nightly](https://github.com/rust-lang/rust/pull/132993) in rustc version detection. ([5b2847a](https://github.com/taiki-e/portable-atomic/commit/5b2847a8b99aa2a57a6c80f5a47327b2764f08cc)) ## [0.2.3] - 2024-10-17 diff --git a/portable-atomic-util/README.md b/portable-atomic-util/README.md index 47607c89..199d10d9 100644 --- a/portable-atomic-util/README.md +++ b/portable-atomic-util/README.md @@ -54,13 +54,16 @@ Or set environment variable: RUSTFLAGS="--cfg portable_atomic_unstable_coerce_unsized" cargo ... ``` -- **`--cfg portable_atomic_unstable_coerce_unsized`**
support standard coercing of `Arc` to `Arc` +- **`--cfg portable_atomic_unstable_coerce_unsized`**
+ Support coercing of `Arc` to `Arc` as in `std::sync::Arc`. - + -This coercing requires Rust nightly to compile (with help from [unstable `CoerceUnsized` trait](https://doc.rust-lang.org/nightly/core/ops/trait.CoerceUnsized.html)). + This cfg requires Rust nightly because this coercing requires [unstable `CoerceUnsized` trait](https://doc.rust-lang.org/nightly/core/ops/trait.CoerceUnsized.html). -See [this issue comment](https://github.com/taiki-e/portable-atomic/issues/143#issuecomment-1866488569) for another known workaround. + See [this issue comment](https://github.com/taiki-e/portable-atomic/issues/143#issuecomment-1866488569) for another known workaround. + + **Note:** This cfg is unstable and outside of the normal semver guarantees and minor or patch versions of portable-atomic-util may make breaking changes to them at any time. diff --git a/portable-atomic-util/src/lib.rs b/portable-atomic-util/src/lib.rs index a59a9c3a..64d9ab59 100644 --- a/portable-atomic-util/src/lib.rs +++ b/portable-atomic-util/src/lib.rs @@ -48,13 +48,16 @@ Or set environment variable: RUSTFLAGS="--cfg portable_atomic_unstable_coerce_unsized" cargo ... ``` -- **`--cfg portable_atomic_unstable_coerce_unsized`**
support standard coercing of `Arc` to `Arc` +- **`--cfg portable_atomic_unstable_coerce_unsized`**
+ Support coercing of `Arc` to `Arc` as in `std::sync::Arc`. - + -This coercing requires Rust nightly to compile (with help from [unstable `CoerceUnsized` trait](https://doc.rust-lang.org/nightly/core/ops/trait.CoerceUnsized.html)). + This cfg requires Rust nightly because this coercing requires [unstable `CoerceUnsized` trait](https://doc.rust-lang.org/nightly/core/ops/trait.CoerceUnsized.html). -See [this issue comment](https://github.com/taiki-e/portable-atomic/issues/143#issuecomment-1866488569) for another known workaround. + See [this issue comment](https://github.com/taiki-e/portable-atomic/issues/143#issuecomment-1866488569) for another known workaround. + + **Note:** This cfg is unstable and outside of the normal semver guarantees and minor or patch versions of portable-atomic-util may make breaking changes to them at any time. */