From 34b65db8420ecfec94126483c7c170c270fd2ead Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Wed, 15 Aug 2018 15:22:54 +0200 Subject: document effect of join on memory ordering --- src/libstd/thread/mod.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'src/libstd/thread') diff --git a/src/libstd/thread/mod.rs b/src/libstd/thread/mod.rs index 61c6084a250..b580b1ec510 100644 --- a/src/libstd/thread/mod.rs +++ b/src/libstd/thread/mod.rs @@ -1308,13 +1308,17 @@ impl JoinHandle { &self.0.thread } - /// Waits for the associated thread to finish. + /// Waits for the associated thread to finish. In terms of [atomic memory orderings], + /// the completion of the associated thread synchronizes with this function returning. + /// In other words, all operations performed by that thread are ordered before all + /// operations that happen after `join` returns. /// /// If the child thread panics, [`Err`] is returned with the parameter given /// to [`panic`]. /// /// [`Err`]: ../../std/result/enum.Result.html#variant.Err /// [`panic`]: ../../std/macro.panic.html + /// [atomic memory orderings]: ../../std/sync/atomic/index.html /// /// # Panics /// -- cgit 1.4.1-3-g733a5