Skip to content

zsock_poll also supports eventfd (documentation) #55506

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.

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

Closed
bdunlay opened this issue Mar 6, 2023 · 1 comment · Fixed by #55804
Closed

zsock_poll also supports eventfd (documentation) #55506

bdunlay opened this issue Mar 6, 2023 · 1 comment · Fixed by #55804
Assignees
Labels
area: Base OS Base OS Library (lib/os) area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug

Comments

@bdunlay
Copy link
Contributor

bdunlay commented Mar 6, 2023

Describe the bug
zsock_poll documentation states:

(In Zephyr this function works only with sockets, not arbitrary file descriptors.)

https://docs.zephyrproject.org/3.3.0/connectivity/networking/api/sockets.html#c.zsock_poll

poll() appears to also support the eventfd event source (#22863). I have used both socket fd and eventfd together in poll successfully.

Expected behavior
If eventfd is an officially supported event source for zsock_poll, the documentation should say so.

Impact
Misleading / confusing docs.

Environment (please complete the following information):

  • Version used: Zephyr 3.3.0
@bdunlay bdunlay added the bug The issue is a bug, or the PR is fixing a bug label Mar 6, 2023
@bdunlay bdunlay changed the title zsock_poll documentation also supports eventfd zsock_poll also supports eventfd (documentation) Mar 6, 2023
@henrikbrixandersen
Copy link
Member

Please use our bug template when reporting bugs. You need to edit this issue to include the needed information from https://github.com/zephyrproject-rtos/zephyr/blob/main/.github/ISSUE_TEMPLATE/bug_report.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Base OS Base OS Library (lib/os) area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants