Module level doc

This commit is contained in:
Geoff Yoerger
2017-01-19 20:38:26 -06:00
committed by GitHub
parent f0b4207598
commit b4192aa4df
+2 -1
View File
@@ -21,9 +21,10 @@
//!
//! Each method takes an `Ordering` which represents the strength of
//! the memory barrier for that operation. These orderings are the
//! same as [LLVM atomic orderings][1].
//! same as [LLVM atomic orderings][1]. For more information see the [nomicon][2]
//!
//! [1]: http://llvm.org/docs/LangRef.html#memory-model-for-concurrent-operations
//! [2]: https://doc.rust-lang.org/nomicon/atomics.html
//!
//! Atomic variables are safe to share between threads (they implement `Sync`)
//! but they do not themselves provide the mechanism for sharing and follow the