drivers/timers/capture: fix typo in capture.h #16925
Conversation
This commit fixes a typo in the capture.h header file (fix apache#16835). Change: CAPIOC_FREQUENCE -> CAPIOC_FREQUENCY Added a compiler warning of the deprecation to the capture.h file. Updated capture driver and documentation. Signed-off-by: Côme VINCENT <[email protected]>
| #define CAPIOC_FREQUENCE CAPIOC_FREQUENCY | ||
|
|
||
| #if defined(__clang__) | ||
| #pragma clang deprecated("CAPIOC_FREQUENCE", "Use CAPIOC_FREQUENCY; CAPIOC_FREQUENCE will be removed on 2026-01-01") |
There was a problem hiding this comment.
Are you the one that is going to remember and remove this on new year's day?
There was a problem hiding this comment.
@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
| /* Deprecated alias: keep object-like so existing code compiles unchanged */ | ||
| #define CAPIOC_FREQUENCE CAPIOC_FREQUENCY | ||
|
|
||
| #if defined(__clang__) |
There was a problem hiding this comment.
not good to check compiler in the common code
|
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 letter maintenance and to warn users about APIs that will change. |
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.