about summary refs log tree commit diff
diff options
context:
space:
mode:
authorsteveklabnik <steve@steveklabnik.com>2018-03-19 14:33:39 +0100
committersteveklabnik <steve@steveklabnik.com>2018-03-19 14:34:51 +0100
commitdeae8de673af638537421804b360443af76d55e4 (patch)
tree73ef9c48a534870ced210835364fe424d50908d6
parenta04b88d1941644df01fa5e31dd43e0f57c13d938 (diff)
downloadrust-deae8de673af638537421804b360443af76d55e4.tar.gz
rust-deae8de673af638537421804b360443af76d55e4.zip
Clarify AcqRel's docs
This implied things that are not true.

Fixes #49127
-rw-r--r--src/libcore/sync/atomic.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/libcore/sync/atomic.rs b/src/libcore/sync/atomic.rs
index 25827edee7d..fd6e5140a09 100644
--- a/src/libcore/sync/atomic.rs
+++ b/src/libcore/sync/atomic.rs
@@ -205,8 +205,9 @@ pub enum Ordering {
     /// [`Release`]: http://llvm.org/docs/Atomics.html#release
     #[stable(feature = "rust1", since = "1.0.0")]
     Acquire,
-    /// When coupled with a load, uses [`Acquire`] ordering, and with a store
-    /// [`Release`] ordering.
+    /// Has the effects of both [`Acquire`] and [`Release`] together.
+    ///
+    /// If you only are concerned about a load or a store, consider using one of those instead.
     ///
     /// [`Acquire`]: http://llvm.org/docs/Atomics.html#acquire
     /// [`Release`]: http://llvm.org/docs/Atomics.html#release