Merge #13

bors[bot] · adamgreig · bors[bot] · commit 0c8f10e28d6c · 2018-10-30T21:18:25.000Z
13: Add note about mutex unsafety on multi-core systems r=japaric a=adamgreig See #12. Co-authored-by: Adam Greig <adam@adamgreig.com>
diff --git a/src/lib.rs b/src/lib.rs
@@ -69,6 +69,12 @@ impl CriticalSection {
 }
 
 /// A "mutex" based on critical sections
+///
+/// # Safety
+///
+/// **This Mutex is only safe on single-core systems.**
+///
+/// On multi-core systems, a `CriticalSection` **is not sufficient** to ensure exclusive access.
 pub struct Mutex<T> {
     inner: UnsafeCell<T>,
 }

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,12 @@ impl CriticalSection {`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/// A "mutex" based on critical sections`
	`72`	`+///`
	`73`	`+/// # Safety`
	`74`	`+///`
	`75`	`+/// This Mutex is only safe on single-core systems.`
	`76`	`+///`
	`77`	+/// On multi-core systems, a `CriticalSection` is not sufficient to ensure exclusive access.
`72`	`78`	`pub struct Mutex<T> {`
`73`	`79`	`inner: UnsafeCell<T>,`
`74`	`80`	`}`