Skip to content

Incorrect documentation for k_work_*() API #14109

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
Closed
pizi-nordic opened this issue Mar 6, 2019 · 1 comment
Closed

Incorrect documentation for k_work_*() API #14109

pizi-nordic opened this issue Mar 6, 2019 · 1 comment
Assignees
@andyross
Labels
area: Documentation area: Kernel bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug

Comments

@pizi-nordic
Copy link
Collaborator

The documentation of k_work_*() API mentions that the error code -EINPROGRESS is returned when given operation is performed on the work which is pending. Unfortunately such code is never returned.
Either documentation or implementation should be corrected.
@pizi-nordic pizi-nordic added the bug The issue is a bug, or the PR is fixing a bug label Mar 6, 2019
@pizi-nordic
Copy link
Collaborator Author

FYI: @nashif, @carlescufi, @pdunaj

@carlescufi carlescufi added the priority: low Low impact/importance bug label Mar 6, 2019
andyross pushed a commit to andyross/zephyr that referenced this issue Mar 8, 2019
include/kernel.h: Remove unsupported return values from k_work APIs
62ff353 
Nothing in the code actually returns -EINPROGRESS, and in the case of
k_work_init() I don't see how that can even be done in a reliable way.
Don't claim we do what we don't.  Fixes zephyrproject-rtos#14109.

Signed-off-by: Andy Ross <[email protected]>
@andyross andyross mentioned this issue Mar 8, 2019
Merged
nashif pushed a commit that referenced this issue Mar 8, 2019
@nashif
include/kernel.h: Remove unsupported return values from k_work APIs
2611e2d 
Nothing in the code actually returns -EINPROGRESS, and in the case of
k_work_init() I don't see how that can even be done in a reliable way.
Don't claim we do what we don't.  Fixes #14109.

Signed-off-by: Andy Ross <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andyross andyross

Labels
area: Documentation area: Kernel bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@andyross @carlescufi @pizi-nordic @aescolar