Skip to content

FIFO: Clarify doc for k_fifo_alloc_put #15090

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
paulgavrikov opened this issue Apr 1, 2019 · 1 comment
Closed

FIFO: Clarify doc for k_fifo_alloc_put #15090

paulgavrikov opened this issue Apr 1, 2019 · 1 comment
Assignees
@andrewboie
Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug

Comments

@paulgavrikov
Copy link

Describe the bug
The doc for `k_fifo_alloc_put``makes it sound as if the actual data is allocated but only the head is.

Expected behavior
Point out that data isn't stored in the FIFO. E.g.:

Note: The data is not allocated and needs to remain valid.
@paulgavrikov paulgavrikov added the bug The issue is a bug, or the PR is fixing a bug label Apr 1, 2019
@paulgavrikov
Copy link
Author

@jhedberg

@andrewboie andrewboie self-assigned this Apr 1, 2019
andrewboie pushed a commit to andrewboie/zephyr that referenced this issue Apr 1, 2019
doc: clarify k_queue_alloc_append and related APIs
3b7399b 
The data isn't copied, there's just an additional implicit
allocation.

Fixes: zephyrproject-rtos#15090

Signed-off-by: Andrew Boie <[email protected]>
@andrewboie andrewboie mentioned this issue Apr 1, 2019
Merged
@andrewboie andrewboie added the priority: low Low impact/importance bug label Apr 1, 2019
nashif pushed a commit that referenced this issue Apr 1, 2019
@nashif
doc: clarify k_queue_alloc_append and related APIs
ac3dcc1 
The data isn't copied, there's just an additional implicit
allocation.

Fixes: #15090

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

@andrewboie andrewboie

Labels
area: Documentation 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
3 participants
@jhedberg @andrewboie @paulgavrikov