Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Unbury the lede on tokio::sync::mutex docs #6819

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Unbury the lede on tokio::sync::mutex docs #6819

wants to merge 1 commit into from

Conversation

tbodt
Copy link

@tbodt tbodt commented Sep 4, 2024

@github-actions github-actions bot added the R-loom-sync Run loom sync tests on this PR label Sep 4, 2024
@tbodt tbodt mentioned this pull request Sep 4, 2024
Open
@Noah-Kennedy
Copy link
Contributor

I think the specific interaction with block_on, LocalSet or (the proposed) LocalRuntime needs to be called out here, as this is not possible to do within a "normal" task.

@Darksonn Darksonn added T-docs Topic: documentation A-tokio Area: The main tokio crate M-sync Module: tokio/sync labels Sep 11, 2024
Darksonn
Darksonn reviewed Sep 11, 2024
View reviewed changes
tokio/src/sync/mutex.rs
Comment on lines -26 to +30
/// Contrary to popular belief, it is ok and often preferred to use the ordinary
/// [`Mutex`][std] from the standard library in asynchronous code.
/// The ordinary std [`Mutex`][std] cannot be held across an `.await` point -
/// your program will deadlock if you do this. Use the async mutex instead in
/// such cases. However, it is ok and often preferred to use the std mutex in
/// asynchronous tasks when it does not need to be held across an `.await`
/// point.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should just delete the first paragraph?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe, or label this a TL;DR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Darksonn Darksonn Darksonn left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
A-tokio Area: The main tokio crate M-sync Module: tokio/sync R-loom-sync Run loom sync tests on this PR T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Doc of mutex advising std blocking mutex look totally misleading
3 participants
@tbodt @Noah-Kennedy @Darksonn