include: uart: Another pass on improving docstrings #10761
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #10761 +/- ##
=======================================
Coverage 53.08% 53.08%
=======================================
Files 215 215
Lines 25820 25820
Branches 5692 5692
=======================================
Hits 13707 13707
Misses 9803 9803
Partials 2310 2310Continue to review full report at Codecov.
|
pfalcon
force-pushed
the
uart-better-docstrings
branch
from
36c9935
to
f131edd
Compare
|
@gon1332: FYI, feel free to have a look/review. |
gon1332
reviewed
Oct 23, 2018
include/uart.h
Outdated
| @@ -578,6 +596,7 @@ static inline int _impl_uart_irq_update(struct device *dev) | |||
| * | |||
| * This sets up the callback for IRQ. When an IRQ is triggered, | |||
| * the specified function will be called with specified user data. | |||
| * See description of uart_urq_update() for requirements on the ISR. | |||
There was a problem hiding this comment.
typo in "uart_irq_update()"
|
Fixed, thanks.
|
1. Avoid outdated references to registers of a particular hardware in the generic API. 2. Propagate specifications/clarifications of ISR behavior to docstrings of more functions which guaranteed to work only in ISR. This continues work previously done in: 38f78e8 0fdc9b5 etc. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
pfalcon
force-pushed
the
uart-better-docstrings
branch
from
f131edd
to
34a3541
Compare
|
This came as a side effect of reviewing UART driver in #9042, and seeing that the bunch of docstrings don't mention constraints specified in other docstrings. And going over this for Nth, with everything else happening inbetween (like, people spawning more drivers with raw ISRs for UART access, weird bugreports), following thoughts are dawning:
|
|
Ping. |
nashif
approved these changes
Oct 30, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Avoid outdated references to registers of a particular hardware
in the generic API.
Propagate specifications/clarifications of ISR behavior to
docstrings of more functions which guaranteed to work only in ISR.
This continues work previously done in:
38f78e8
0fdc9b5
etc.
Signed-off-by: Paul Sokolovsky paul.sokolovsky@linaro.org