os: callout without event queue (doc vs code)
- Dominant language
- C
- Stars
- 891
- Forks
- 381
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 14
Description
Callout documentation makes it believe that an event queue is required to process callout callback, this requirement is not present in the code. If no queue is specified callback is processed in interupt context. Doc will need to be updated accordingly.
https://github.com/apache/mynewt-core/blob/e0d46d6f58bcc81a74536591e03560458f349b14/kernel/os/src/os_callout.c#L128-L132
Documentation also make mention of `OS_EVENT_T_TIMER` which is not defined anywhere
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with kernel/os/src/os_callout.c at lines 128-132, then locate the callout documentation that describes callback processing. Verify the documentation against the code, clarify behavior when no event queue is specified, and remove or correct the reference to the undefined OS_EVENT_T_TIMER; done when the documentation matches the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation, operating-systems
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100