RwLock: refine documentation to emphasize non-reentrancy guarantees#152056
Merged
rust-bors[bot] merged 1 commit intorust-lang:mainfrom Feb 8, 2026
Merged
Conversation
rustbot
added
S-waiting-on-review
Collaborator
This comment has been minimized.
This comment has been minimized.
Contributor
Author
This addresses the need for clarification brought up in an issue.
Specifically, it notes that some implementations may choose to panic if
they detect deadlock situations during recursive locking attempts for
both `read()` and `write()` calls.
* Provide an example highlighting that multiple read locks can be
held across different threads simultaneously.
* Remove the example that shows a situation that can potentially deadlock.
(as demonstrated in the very same documentation a few paragraphs
above)
* Improve documentation regarding the possibility of panics during
recursive read or write lock attempts.
Issues: Ambiguity in RwLock documentation about multiple read() calls...
Signed-off-by: Henner Zeller <h.zeller@acm.org>
hzeller
force-pushed
the
feature-20260203-clarify-rwlock-reentrance
branch
from
df4cbf5 to
27f97d7
Compare
Member
|
Indeed, that's much better, thank you! |
Contributor
rust-bors
bot
added
S-waiting-on-bors
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Feb 7, 2026
…wlock-reentrance, r=joboet RwLock: refine documentation to emphasize non-reentrancy guarantees This addresses the need for clarification brought up in rust-lang#149693. Specifically, it notes that some implementations may choose to panic if they detect deadlock situations during recursive locking attempts for both `read()` and `write()` calls. * Provide an example highlighting that multiple read locks can be held across different threads simultaneously. * Remove the example that shows a situation that can potentially deadlock. (as demonstrated in the very same documentation a few paragraphs above) * Improve documentation regarding the possibility of panics during recursive read or write lock attempts. Issues: rust-lang#149693
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Feb 7, 2026
…wlock-reentrance, r=joboet RwLock: refine documentation to emphasize non-reentrancy guarantees This addresses the need for clarification brought up in rust-lang#149693. Specifically, it notes that some implementations may choose to panic if they detect deadlock situations during recursive locking attempts for both `read()` and `write()` calls. * Provide an example highlighting that multiple read locks can be held across different threads simultaneously. * Remove the example that shows a situation that can potentially deadlock. (as demonstrated in the very same documentation a few paragraphs above) * Improve documentation regarding the possibility of panics during recursive read or write lock attempts. Issues: rust-lang#149693
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Feb 7, 2026
…wlock-reentrance, r=joboet RwLock: refine documentation to emphasize non-reentrancy guarantees This addresses the need for clarification brought up in rust-lang#149693. Specifically, it notes that some implementations may choose to panic if they detect deadlock situations during recursive locking attempts for both `read()` and `write()` calls. * Provide an example highlighting that multiple read locks can be held across different threads simultaneously. * Remove the example that shows a situation that can potentially deadlock. (as demonstrated in the very same documentation a few paragraphs above) * Improve documentation regarding the possibility of panics during recursive read or write lock attempts. Issues: rust-lang#149693
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Feb 7, 2026
…wlock-reentrance, r=joboet RwLock: refine documentation to emphasize non-reentrancy guarantees This addresses the need for clarification brought up in rust-lang#149693. Specifically, it notes that some implementations may choose to panic if they detect deadlock situations during recursive locking attempts for both `read()` and `write()` calls. * Provide an example highlighting that multiple read locks can be held across different threads simultaneously. * Remove the example that shows a situation that can potentially deadlock. (as demonstrated in the very same documentation a few paragraphs above) * Improve documentation regarding the possibility of panics during recursive read or write lock attempts. Issues: rust-lang#149693
rust-bors bot
pushed a commit
that referenced
this pull request
Feb 7, 2026
…uwer Rollup of 7 pull requests Successful merges: - #151745 (Remove a couple of unnecessary flags and env vars in bootstrap) - #152217 (Convert to inline diagnostics in `rustc_lint`) - #152056 (RwLock: refine documentation to emphasize non-reentrancy guarantees) - #152261 (Introduce helper `ty::Generics::has_own_self`) - #152288 (Allow only a single accepter per attribute) - #152292 (Minor change for readability) - #152300 (Port `rustc_regions` to the new attribute parser)
rust-bors bot
pushed a commit
that referenced
this pull request
Feb 7, 2026
…uwer Rollup of 7 pull requests Successful merges: - #151745 (Remove a couple of unnecessary flags and env vars in bootstrap) - #152217 (Convert to inline diagnostics in `rustc_lint`) - #152056 (RwLock: refine documentation to emphasize non-reentrancy guarantees) - #152261 (Introduce helper `ty::Generics::has_own_self`) - #152288 (Allow only a single accepter per attribute) - #152292 (Minor change for readability) - #152300 (Port `rustc_regions` to the new attribute parser)
rust-bors bot
pushed a commit
that referenced
this pull request
Feb 7, 2026
…uwer Rollup of 7 pull requests Successful merges: - #151745 (Remove a couple of unnecessary flags and env vars in bootstrap) - #152217 (Convert to inline diagnostics in `rustc_lint`) - #152056 (RwLock: refine documentation to emphasize non-reentrancy guarantees) - #152261 (Introduce helper `ty::Generics::has_own_self`) - #152288 (Allow only a single accepter per attribute) - #152292 (Minor change for readability) - #152300 (Port `rustc_regions` to the new attribute parser)
rust-bors bot
pushed a commit
that referenced
this pull request
Feb 7, 2026
…uwer Rollup of 7 pull requests Successful merges: - #151745 (Remove a couple of unnecessary flags and env vars in bootstrap) - #152217 (Convert to inline diagnostics in `rustc_lint`) - #152056 (RwLock: refine documentation to emphasize non-reentrancy guarantees) - #152261 (Introduce helper `ty::Generics::has_own_self`) - #152288 (Allow only a single accepter per attribute) - #152292 (Minor change for readability) - #152300 (Port `rustc_regions` to the new attribute parser)
rust-timer
added a commit
that referenced
this pull request
Feb 8, 2026
Rollup merge of #152056 - hzeller:feature-20260203-clarify-rwlock-reentrance, r=joboet RwLock: refine documentation to emphasize non-reentrancy guarantees This addresses the need for clarification brought up in #149693. Specifically, it notes that some implementations may choose to panic if they detect deadlock situations during recursive locking attempts for both `read()` and `write()` calls. * Provide an example highlighting that multiple read locks can be held across different threads simultaneously. * Remove the example that shows a situation that can potentially deadlock. (as demonstrated in the very same documentation a few paragraphs above) * Improve documentation regarding the possibility of panics during recursive read or write lock attempts. Issues: #149693
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This addresses the need for clarification brought up in #149693. Specifically, it notes that some implementations may choose to panic if they detect deadlock situations during recursive locking attempts for both
read()andwrite()calls.Issues: #149693