-
Notifications
You must be signed in to change notification settings - Fork 215
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
Fix #1353, Align mismatched function prototype/implem. parameter names #1354
Fix #1353, Align mismatched function prototype/implem. parameter names #1354
Conversation
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.
I concur with the general desire to make the names of the parameters consistent between the declaration and definition, but in this case the names in the headers (API) are probably the preferred names for these values. For example, in the "timebase" module, the IDs should all be "timebase_id" rather than "timer_id" (the latter probably a remnant of cut-and-paste from the timer API). Somewhere along the way, the headers got updated appropriately, but the implementation wasn't. We should just update the implementation, not revert the header.
As a side note, cppcheck should be finding and reporting differences in these parameter names, but does not seem to be flagging these items. This might point to a problem with our cppcheck workflow not covering everything it is supposed to.
c0c8b3c
to
5f664fe
Compare
5f664fe
to
a92b2b7
Compare
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.
Great, thanks!
*Combines:* cFE equuleus-rc1+dev96 osal equuleus-rc1+dev53 to_lab equuleus-rc1+dev44 **Includes:** *cFE* - nasa/cFE#2515 - nasa/cFE#2330 *osal* - nasa/osal#1448 - nasa/osal#1146 - nasa/osal#1357 - nasa/osal#1354 - nasa/osal#1331 *to_lab* - nasa/to_lab#191 - nasa/to_lab#136 Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com> Co-authored by: Avi Weiss <thnkslprpt@users.noreply.github.com> Co-authored by: Sam Price <thesamprice@users.noreply.github.com>
*Combines:* cFE equuleus-rc1+dev96 osal equuleus-rc1+dev53 to_lab equuleus-rc1+dev44 **Includes:** *cFE* - nasa/cFE#2515 - nasa/cFE#2330 *osal* - nasa/osal#1448 - nasa/osal#1146 - nasa/osal#1357 - nasa/osal#1354 - nasa/osal#1331 *to_lab* - nasa/to_lab#191 - nasa/to_lab#136 Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com> Co-authored by: Avi Weiss <thnkslprpt@users.noreply.github.com> Co-authored by: Sam Price <thesamprice@users.noreply.github.com>
Checklist
Describe the contribution
May as well clean these up now to avoid any potential future compiler warnings and ease maintainability/readability.
Note: one of these cases was noticed in #185, but closed as 'won't fix' at the time.
Testing performed
GitHub CI actions (incl. Build + Run, Unit Tests etc.) all passing successfully.
Expected behavior changes
Function prototypes and their implementations should (ideally) always have matching parameter names.
Contributor Info
Avi Weiss @thnkslprpt