doc: uart: Make sure poll_in is non-blocking #45536
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yashi
force-pushed
the
fix-uart-poll-in-as-non-blocking
branch
from
cd29eb4 to
1c54c4a
Compare
The documentation has wrongly stated that the function uart_poll_in() is also a blocking function. The uart_poll_out() is indeed a blocking function but uart_poll_in() has never been since day one. Make it clear that the uart_poll_in() is a NON-blocking function, and uart_poll_out() IS a blocking. This fixes zephyrproject-rtos#45468. Signed-off-by: Yasushi SHOJI <[email protected]>
yashi
force-pushed
the
fix-uart-poll-in-as-non-blocking
branch
from
1c54c4a to
c70fdbc
Compare
dcpleung
approved these changes
May 11, 2022
mbolivar-nordic
approved these changes
May 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation has wrongly stated that the function
uart_poll_in()is also a blocking function. Theuart_poll_out()is indeed a blocking function butuart_poll_in()has never been since day one.Make it clear that the
uart_poll_in()is a non-blocking function, anduart_poll_out()is a blocking.This fixes #45468.
Signed-off-by: Yasushi SHOJI [email protected]