-
Notifications
You must be signed in to change notification settings - Fork 1.5k
drivers/timers/capture: fix typo in capture.h #16925
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
base: master
Are you sure you want to change the base?
Conversation
acassis
left a comment
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.
@comejv maybe it should better to create a DEPRECATED macro that accept the symbol/function and the due date. Also we could include a test the convert it in an error to alert people to remove that function case the due date has passed
|
Why not just correct the typo without any additional warnings and delete the old define? |
|
@comejv just fix like raiden suggested and fix the typo CAPIOC_FREQUENCE. But I think the idea of creating a macro to define a DEPRECATED feature is interesting for later maintenance and to warn users about APIs that will change. |
|
Hey @comejv, if you can update this PR to follow raiden00pl's suggestion it can be merged! |
|
ping @comejv |
This commit fixes a typo in the capture.h header file. This is a breaking change, but the fix is trivial (replace macro with new one). Signed-off-by: Côme VINCENT <[email protected]>
587b6c0 to
80c2e47
Compare
|
Sorry for the (long) delay, finished the job that had me working with nuttx and then forgot about it. Tell me if the commit message should reflect that it is a breaking change more. |
|
The job Linux (arm64-01) fails with this output:
Is there something I'm supposed to do about that? At first glance it doesn't look related to my changes. |
|
fixed here: apache/nuttx-apps#3349 |
|
@comejv apps side need fix: |
Summary
This commit fixes a typo in the capture.h header file (fix #16835).
Change: CAPIOC_FREQUENCE -> CAPIOC_FREQUENCY
Added a compiler warning of the deprecation to the capture.h file.
Updated capture driver and documentation.
Impact
Now shows a compiler warning when using the capture driver. Old spelling is aliased to the new spelling. Should be removed in future releases.
Testing
Built config capture on Ubuntu.