Commit 1a6485d111

IntegratedQuantum <43880493+IntegratedQuantum@users.noreply.github.com>
2024-04-24 17:41:13
Clarify the blocking behavior of `RwLock.lockShared()`. (#19752)
1 parent f6f7a47
Changed files (1)
lib
std
Thread
lib/std/Thread/RwLock.zig
@@ -41,7 +41,9 @@ pub fn tryLockShared(rwl: *RwLock) bool {
     return rwl.impl.tryLockShared();
 }
 
-/// Blocks until shared lock ownership is acquired.
+/// Obtains shared lock ownership.
+/// Blocks if another thread has exclusive ownership.
+/// May block if another thread is attempting to get exclusive ownership.
 pub fn lockShared(rwl: *RwLock) void {
     return rwl.impl.lockShared();
 }