-
Notifications
You must be signed in to change notification settings - Fork 6.5k
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
include: uart: Another pass on improving docstrings #10761
include: uart: Another pass on improving docstrings #10761
Conversation
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 2310 Continue to review full report at Codecov.
|
36c9935
to
f131edd
Compare
@gon1332: FYI, feel free to have a look/review. |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
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. |
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