Auto merge of #33034 - tbu-:pr_doc_mutex_lock, r=nagisa

Add a comment about locking a `Mutex` multiple times

Fixes #32260.
This commit is contained in:
bors 2016-04-17 14:00:56 -07:00
commit ed7c56796e

View File

@ -205,10 +205,19 @@ impl<T: ?Sized> Mutex<T> {
/// held. An RAII guard is returned to allow scoped unlock of the lock. When
/// the guard goes out of scope, the mutex will be unlocked.
///
/// The exact behavior on locking a mutex in the thread which already holds
/// the lock is left unspecified, however, this function will not return on
/// the second call, it might e.g. panic or deadlock.
///
/// # Errors
///
/// If another user of this mutex panicked while holding the mutex, then
/// this call will return an error once the mutex is acquired.
///
/// # Panics
///
/// This function might panic when called if the lock is already held by
/// the current thread.
#[stable(feature = "rust1", since = "1.0.0")]
pub fn lock(&self) -> LockResult<MutexGuard<T>> {
unsafe {