Skip to content

Fix RwLock::try_write documentation for WouldBlock condition #142967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 27, 2025

Conversation

krikera
Copy link
Contributor

@krikera krikera commented Jun 24, 2025

Fix RwLock::try_write documentation for WouldBlock condition

The documentation incorrectly stated that try_write only fails when
'already locked exclusively', but it actually fails when there are
either shared (read) or exclusive (write) locks.

Fixes #142852

@rustbot
Copy link
Collaborator

rustbot commented Jun 24, 2025

r? @jhpratt

rustbot has assigned @jhpratt.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jun 24, 2025
@rustbot

This comment has been minimized.

@krikera krikera force-pushed the fix-rwlock-try-write-docs branch from 89ea835 to bd76559 Compare June 24, 2025 15:12
@jhpratt
Copy link
Member

jhpratt commented Jun 25, 2025

I'd prefer simply removing the word "exclusively", keeping the explanation as simple as possible.

@jhpratt jhpratt added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 25, 2025
@jhpratt
Copy link
Member

jhpratt commented Jun 25, 2025

Can you squash this into a single commit for simplicity? r=me when that's done.

@bors delegate+ rollup

@bors
Copy link
Collaborator

bors commented Jun 25, 2025

✌️ @krikera, you can now approve this pull request!

If @jhpratt told you to "r=me" after making some further change, please make that change, then do @bors r=@jhpratt

@krikera krikera force-pushed the fix-rwlock-try-write-docs branch from bf8fa87 to 7a70f64 Compare June 26, 2025 10:04
@krikera
Copy link
Contributor Author

krikera commented Jun 26, 2025

@bors r=@jhpratt

@bors
Copy link
Collaborator

bors commented Jun 26, 2025

📌 Commit 7a70f64 has been approved by jhpratt

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 26, 2025
compiler-errors added a commit to compiler-errors/rust that referenced this pull request Jun 26, 2025
… r=jhpratt

Fix RwLock::try_write documentation for WouldBlock condition

Fix RwLock::try_write documentation for WouldBlock condition

The documentation incorrectly stated that try_write only fails when
'already locked exclusively', but it actually fails when there are
either shared (read) or exclusive (write) locks.

Fixes rust-lang#142852
bors added a commit that referenced this pull request Jun 27, 2025
…rors

Rollup of 18 pull requests

Successful merges:

 - #137843 (make RefCell unstably const)
 - #140942 (const-eval: allow constants to refer to mutable/external memory, but reject such constants as patterns)
 - #142549 (small iter.intersperse.fold() optimization)
 - #142637 (Remove some glob imports from the type system)
 - #142647 ([perf] Compute hard errors without diagnostics in impl_intersection_has_impossible_obligation)
 - #142700 (Remove incorrect comments in `Weak`)
 - #142927 (Add note to `find_const_ty_from_env`)
 - #142967 (Fix RwLock::try_write documentation for WouldBlock condition)
 - #142986 (Port `#[export_name]` to the new attribute parsing infrastructure)
 - #143001 (Rename run always )
 - #143010 (Update `browser-ui-test` version to `0.20.7`)
 - #143015 (Add `sym::macro_pin` diagnostic item for `core::pin::pin!()`)
 - #143033 (Expand const-stabilized API links in relnotes)
 - #143041 (Remove cache for citool)
 - #143056 (Move an ACE test out of the GCI directory)
 - #143059 (Fix 1.88 relnotes)
 - #143067 (Tracking issue number for `iter_macro`)
 - #143073 (Fix some fixmes that were waiting for let chains)

Failed merges:

 - #143020 (codegen_fn_attrs: make comment more precise)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit c5ac143 into rust-lang:master Jun 27, 2025
10 checks passed
@rustbot rustbot added this to the 1.90.0 milestone Jun 27, 2025
rust-timer added a commit that referenced this pull request Jun 27, 2025
Rollup merge of #142967 - krikera:fix-rwlock-try-write-docs, r=jhpratt

Fix RwLock::try_write documentation for WouldBlock condition

Fix RwLock::try_write documentation for WouldBlock condition

The documentation incorrectly stated that try_write only fails when
'already locked exclusively', but it actually fails when there are
either shared (read) or exclusive (write) locks.

Fixes #142852
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RwLock::try_write should say that it fails with WouldBlock if there's a shared lock
4 participants