Add utility functions for configuring gpio interrupts and document file operations.
Details
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 66645 Build 63528: arc lint + arc unit
Event Timeline
The code looks okay, just a few notes on the man page & comments. I think that the man page should document both GPIO_EVENT_REPORT_DETAIL and GPIO_EVENT_REPORT_SUMMARY.
Also adding @ziaee for review.
| lib/libgpio/gpio.3 | ||
|---|---|---|
| 167 | I think referring to the enum in sys/gpio.h here would make more sense. | |
| 171 | Ditto | |
| 174–177 | This should clarify that the call will fail only if the pin is configured for interrupts. | |
| 198 | These should be wrapped at 72 characters. | |
| lib/libgpio/libgpio.h | ||
| 108–110 | ||
Document GPIO_EVENT_REPORT_DETAIL and GPIO_EVENT_REPORT_SUMMARY.
Limit lines to 72 characters.
Clarify gpio_configure_events failures.
Change wording from delivery type to report type.
Looks good, although I think the header should use .In
| lib/libgpio/gpio.3 | ||
|---|---|---|
| 187 | I see that the man page uses this further up too. IMO both should be changed to use .In | |
Change syntax for header documentation, and document return code for gpio_configure_events