about summary refs log tree commit diff
path: root/src/libcore/sync
diff options
context:
space:
mode:
authorStefan Schindler <dns2utf8@estada.ch>2018-02-16 10:30:31 +0100
committerStefan Schindler <dns2utf8@estada.ch>2018-02-16 10:30:31 +0100
commit3bf989f4c945e91c2ff99ac66ef0f6405e975ff4 (patch)
treebd18d52f58e567ccd83a6ba3c5b6d16cb2a65fb3 /src/libcore/sync
parent5570cdcc9e7da0cca84e394e872bc16df2c6dc50 (diff)
downloadrust-3bf989f4c945e91c2ff99ac66ef0f6405e975ff4.tar.gz
rust-3bf989f4c945e91c2ff99ac66ef0f6405e975ff4.zip
Add link to yield_now
Diffstat (limited to 'src/libcore/sync')
-rw-r--r--src/libcore/sync/atomic.rs7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/libcore/sync/atomic.rs b/src/libcore/sync/atomic.rs
index f22862ae701..63fb6e437e4 100644
--- a/src/libcore/sync/atomic.rs
+++ b/src/libcore/sync/atomic.rs
@@ -97,9 +97,10 @@ use fmt;
 /// Save power or switch hyperthreads in a busy-wait spin-loop.
 ///
 /// This function is deliberately more primitive than
-/// `std::thread::yield_now` and does not directly yield to the
-/// system's scheduler.  In some cases it might be useful to use a
-/// combination of both functions.  Careful benchmarking is advised.
+/// [`std::thread::yield_now`](../../thread/fn.yield_now.html) and
+/// does not directly yield to the system's scheduler.
+/// In some cases it might be useful to use a combination of both functions.
+/// Careful benchmarking is advised.
 ///
 /// On some platforms this function may not do anything at all.
 #[inline]