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

sys/event: Add documentation and enforce waiter on wait #17952

Merged
merged 2 commits into from Apr 19, 2022
Merged

sys/event: Add documentation and enforce waiter on wait #17952

merged 2 commits into from Apr 19, 2022

Conversation

leandrolanzieri
Copy link
Contributor

Contribution description

  • d3ee32f explicitly documents that a queue needs to be initialized (either attached or detached) before posting events to it.
  • b3b76bf documents and enforces that a queue has a waiter assigned before waiting for thread flags.

Testing procedure

  • tests/events should work as usual

Issues/PRs references

None

@leandrolanzieri
sys/event: add queue initialization pre-cond to event_post
d3ee32f 
Document that a queue should have been initialized before posting events
to it.
@leandrolanzieri
sys/event: ensure that a queue has a waiter before waiting for flags
b3b76bf 
Document and enforce that a queue has a waiter (i.e. it is claimed)
before waiting for thread flags.
@leandrolanzieri leandrolanzieri added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label Apr 14, 2022
@github-actions github-actions bot added the Area: sys Area: System label Apr 14, 2022
@benpicco benpicco requested a review from jia200x April 14, 2022 15:20
@benpicco benpicco added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Apr 14, 2022
@kaspar030 kaspar030 merged commit 56fdc90 into RIOT-OS:master Apr 19, 2022
@chrysn chrysn added this to the Release 2022.07 milestone Aug 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maribu maribu maribu approved these changes

@benpicco benpicco Awaiting requested review from benpicco

@kaspar030 kaspar030 Awaiting requested review from kaspar030 kaspar030 is a code owner

@jia200x jia200x Awaiting requested review from jia200x

Assignees
No one assigned
Labels
Area: sys Area: System CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Milestone
Release 2022.07
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@leandrolanzieri @maribu @chrysn @benpicco @kaspar030