Skip to content

Commit 192fbd7

Browse files
committed
doc(r3): mutex unlock order violation is no longer required to be detected by a kernel
This is mostly an obligation imposed upon an application.
1 parent 19ad5b1 commit 192fbd7

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

src/r3/src/kernel/mutex.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ impl<System: raw::KernelMutex> Mutex<System> {
337337

338338
/// Unlock the mutex.
339339
///
340-
/// Mutexes must be unlocked in a lock-reverse order, or this method will
340+
/// Mutexes must be unlocked in a lock-reverse order, or this method may
341341
/// return [`UnlockMutexError::BadObjectState`].
342342
#[inline]
343343
pub fn unlock(self) -> Result<(), UnlockMutexError> {

src/r3/src/sync/mutex.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ pub struct Definer<System, T, InitTag> {
2626
/// calling [`Mutex::mark_consistent`].
2727
///
2828
/// - Mutexes must be unlocked in a lock-reverse order. [`MutexGuard`]`::drop`
29-
/// will panic if this is violated.
29+
/// might panic if this is violated.
3030
///
3131
/// [`r3::kernel::Mutex`]: crate::kernel::Mutex
3232
pub struct Mutex<System, T>

0 commit comments

Comments
 (0)