Document correctness of select! and Poll::Pending #1954
Merged
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.
Motivation
It's tricky to get
select!
andPoll::Pending
code correct.Solution
Document the correctness of Zebra's current
select!
andPoll::Pending
code.Review
Anyone can review, these docs can be merged whenever.
Related Issues
Split off PR #1950 to limit the size of that PR.
Discovered while fixing #1905
Important for getting #1817 correct
Important for getting upcoming security fixes correct