]> git.lizzy.rs Git - rust.git/commitdiff
Add documentation for the `volatile_read` and `volatile_write` intrinsics
authorWesley Wiser <wwiser@gmail.com>
Sat, 5 Nov 2016 23:30:56 +0000 (19:30 -0400)
committerWesley Wiser <wwiser@gmail.com>
Wed, 9 Nov 2016 03:03:23 +0000 (22:03 -0500)
Part of #34338

src/libcore/intrinsics.rs

index ea5544221c9bd1283f1eda6f7661a9eab6e9097b..7f37b744148d16e5bfd42aa059a13473de4a34a2 100644 (file)
@@ -1027,8 +1027,12 @@ pub fn volatile_copy_nonoverlapping_memory<T>(dst: *mut T, src: *const T,
     pub fn volatile_set_memory<T>(dst: *mut T, val: u8, count: usize);
 
     /// Perform a volatile load from the `src` pointer.
+    /// The stabilized version of this intrinsic is
+    /// [`std::ptr::read_volatile`](../../std/ptr/fn.read_volatile.html).
     pub fn volatile_load<T>(src: *const T) -> T;
     /// Perform a volatile store to the `dst` pointer.
+    /// The stabilized version of this intrinsic is
+    /// [`std::ptr::write_volatile`](../../std/ptr/fn.write_volatile.html).
     pub fn volatile_store<T>(dst: *mut T, val: T);
 
     /// Returns the square root of an `f32`