forgot to add comment for some atomic types

kennytm · Aug 7, 2018 · 110bcc9 · 110bcc9
1 parent e9a86a2
commit 110bcc9
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/libcore/sync/atomic.rs b/src/libcore/sync/atomic.rs
@@ -843,7 +843,8 @@ impl<T> AtomicPtr<T> {
     /// was updated.
     ///
     /// `compare_and_swap` also takes an [`Ordering`] argument which describes the memory
-    /// ordering of this operation.
+    /// ordering of this operation. Notice that even when using [`AcqRel`], the operation
+    /// might fail and hence just perform an `Acquire` load, but not have `Release` semantics.
     ///
     /// [`Ordering`]: enum.Ordering.html
     ///
@@ -1202,7 +1203,8 @@ The return value is always the previous value. If it is equal to `current`, then
 value was updated.
 
 `compare_and_swap` also takes an [`Ordering`] argument which describes the memory
-ordering of this operation.
+ordering of this operation. Notice that even when using [`AcqRel`], the operation
+might fail and hence just perform an `Acquire` load, but not have `Release` semantics.
 
 [`Ordering`]: enum.Ordering.html