Skip to content

Document that RawWakerVTable functions must be thread-safe. - #100128

Merged
bors merged 2 commits into
rust-lang:masterfrom
kpreid:waker-doc
Aug 26, 2022
Merged

Document that RawWakerVTable functions must be thread-safe.#100128
bors merged 2 commits into
rust-lang:masterfrom
kpreid:waker-doc

Conversation

@kpreid

@kpreidkpreid commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

Also add some intra-doc links and more high-level explanation of how Waker is used, while I'm here.

Context: https://internals.rust-lang.org/t/thread-safety-of-rawwakervtables/17126

@kpreid
Document that RawWakerVTable functions must be thread-safe.
1b87306
Also add some intra-doc links and more high-level explanation of how
`Waker` is used, while I'm here.
Context:
https://internals.rust-lang.org/t/thread-safety-of-rawwakervtables/17126
@rustbotrustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Aug 4, 2022
@rust-highfive

rust-highfive commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

r? @scottmcm

(rust-highfive has picked a reviewer for you, use r? to override)

@rustbot

rustbot commented Aug 4, 2022

Copy link
Copy Markdown
Collaborator

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 4, 2022
steffahn
steffahn reviewed Aug 4, 2022
View reviewed changes
Comment threadlibrary/core/src/task/wake.rs Outdated
Comment threadlibrary/core/src/task/wake.rs Outdated
Comment threadlibrary/core/src/task/wake.rs Outdated
Comment threadlibrary/core/src/task/wake.rs Outdated
Noratrieb
Noratrieb reviewed Aug 5, 2022
View reviewed changes
Comment threadlibrary/core/src/task/wake.rs
@scottmcm

scottmcm commented Aug 5, 2022

Copy link
Copy Markdown
Member

I don't know enough about tasks/futures to be a good reviewer here.

r? libs

@rust-highfiverust-highfive assigned kennytm and unassigned scottmcmAug 5, 2022
@thomcc

thomcc commented Aug 25, 2022

Copy link
Copy Markdown
Member

r? @thomcc

@rust-highfiverust-highfive assigned thomcc and unassigned kennytmAug 25, 2022
@thomcc

thomcc commented Aug 25, 2022

Copy link
Copy Markdown
Member

Hmm, can someone on @rust-lang/wg-async double-check this?

thomcc
thomcc approved these changes Aug 25, 2022
View reviewed changes

@thomccthomcc left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks fine to me. I kind of would like to have someone from wg-async sign off on it, just to make sure there isn't anything new this is stating subtly

@thomcc

thomcc commented Aug 26, 2022

Copy link
Copy Markdown
Member

After a reread through our APIs and docs I'm convinced this is fine and doesn't make any new guarantees.

@bors r+ rollup

@bors

bors commented Aug 26, 2022

Copy link
Copy Markdown
Collaborator

📌 Commit d4bcc4a has been approved by thomcc

It is now in the queue for this repository.

@borsbors 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-review Status: Awaiting review from the assignee but also interested parties. labels Aug 26, 2022
@GuillaumeGomezGuillaumeGomez mentioned this pull request Aug 26, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 26, 2022
@bors
Auto merge ofrust-lang#101037- GuillaumeGomez:rollup-opn6kj1, r=Gui…
42fa8ac
…llaumeGomez
Rollup of 8 pull requests
Successful merges:
- rust-lang#95005 (BTree: evaluate static type-related check at compile time)
- rust-lang#99742 (Add comments about stdout locking)
- rust-lang#100128 (Document that `RawWakerVTable` functions must be thread-safe.)
- rust-lang#100956 (Reduce right-side DOM size)
- rust-lang#101006 (Fix doc cfg on reexports)
- rust-lang#101012 (rustdoc: remove unused CSS for `.variants_table`)
- rust-lang#101023 (rustdoc: remove `type="text/css"` from stylesheet links)
- rust-lang#101031 (Remove unused build dependency)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 7881e05 into rust-lang:masterAug 26, 2022
@rustbotrustbot added this to the 1.65.0 milestone Aug 26, 2022
@kpreid
kpreid deleted the waker-doc branch August 26, 2022 17:34
@tmandry

tmandry commented Aug 26, 2022

Copy link
Copy Markdown
Member

Thanks for the ping and for the PR, I agree it looks good!

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

Reviewers

@steffahnsteffahnsteffahn left review comments
@NoratriebNoratriebNoratrieb left review comments
@thomccthomccthomcc approved these changes

Assignees

@thomccthomcc

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-libsRelevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.65.0

Development

Successfully merging this pull request may close these issues.

10 participants

@kpreid@rust-highfive@rustbot@scottmcm@thomcc@bors@tmandry@steffahn@Noratrieb@kennytm