Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix #2341, Rename TimeA/TimeB parameter to improve consistency #2342

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix #2341, Rename TimeA/TimeB parameter to improve consistency #2342

wants to merge 1 commit into from

Conversation

thnkslprpt
Copy link
Contributor

Checklist

Describe the contribution

  • Fixes Inconsistent use of Time1/Time2 TimeA/TimeB parameter names #2341
    • Converts TimeA/TimeB parameter names to Time1/Time2 - making all consistent across cFE (the other option is to reverse this and convert the others to TimeA/TimeB)
      • also converts the enumerated types CFE_TIME_A_GT_B and CFE_TIME_A_LT_B to CFE_TIME_1_GT_2 and CFE_TIME_1_LT_2 to remain consistent
      • some test strings using TimeA/TimeB also updated for consistency

Note: If this PR is merged it will require a minor update to SC which utilises the CFE_TIME_A_GT_B enumerated type here and in a couple of tests.

Testing performed
GitHub CI actions all passing successfully (incl. Build + Run, Coverage/Functional Tests etc.).

Expected behavior changes

Contributor Info
Avi Weiss @thnkslprpt

@thnkslprpt thnkslprpt mentioned this pull request May 20, 2023
Open
github-advanced-security[bot]
github-advanced-security bot found potential problems May 20, 2023
View reviewed changes
modules/core_api/ut-stubs/src/cfe_time_stubs.c
{
UT_GenStub_SetupReturnBuffer(CFE_TIME_Compare, CFE_TIME_Compare_t);

UT_GenStub_AddParam(CFE_TIME_Compare, CFE_TIME_SysTime_t, TimeA);
UT_GenStub_AddParam(CFE_TIME_Compare, CFE_TIME_SysTime_t, TimeB);
UT_GenStub_AddParam(CFE_TIME_Compare, CFE_TIME_SysTime_t, Time1);

Check warning

Code scanning / CodeQL

Uses of recursion Warning

The function CFE_TIME_Compare is indirectly recursive via this call to
UT_Stub_RegisterContextWithMetaData
Loading
.
modules/core_api/ut-stubs/src/cfe_time_stubs.c
UT_GenStub_AddParam(CFE_TIME_Compare, CFE_TIME_SysTime_t, TimeA);
UT_GenStub_AddParam(CFE_TIME_Compare, CFE_TIME_SysTime_t, TimeB);
UT_GenStub_AddParam(CFE_TIME_Compare, CFE_TIME_SysTime_t, Time1);
UT_GenStub_AddParam(CFE_TIME_Compare, CFE_TIME_SysTime_t, Time2);

Check warning

Code scanning / CodeQL

Uses of recursion Warning

The function CFE_TIME_Compare is indirectly recursive via this call to
UT_Stub_RegisterContextWithMetaData
Loading
.
modules/time/fsw/src/cfe_time_utils.c
@@ -614,7 +614,7 @@
/*
** Compute the amount of time "since" the tone...
*/
if (CFE_TIME_Compare(Reference->CurrentLatch, Reference->AtToneLatch) == CFE_TIME_A_LT_B)
if (CFE_TIME_Compare(Reference->CurrentLatch, Reference->AtToneLatch) == CFE_TIME_1_LT_2)

Check warning

Code scanning / CodeQL

Uses of recursion Warning

The function CFE_TIME_GetReference is indirectly recursive via this call to
CFE_TIME_Compare
Loading
.
The function CFE_TIME_GetReference is indirectly recursive via this call to
CFE_TIME_Compare
Loading
.
modules/time/fsw/src/cfe_time_utils.c
@@ -614,7 +614,7 @@
/*
** Compute the amount of time "since" the tone...
*/
if (CFE_TIME_Compare(Reference->CurrentLatch, Reference->AtToneLatch) == CFE_TIME_A_LT_B)
if (CFE_TIME_Compare(Reference->CurrentLatch, Reference->AtToneLatch) == CFE_TIME_1_LT_2)

Check warning

Code scanning / CodeQL

Side effect in a Boolean expression Warning

This Boolean expression is not side-effect free.
modules/core_api/ut-stubs/src/cfe_time_stubs.c
@@ -57,12 +57,12 @@
* Generated stub function for CFE_TIME_Compare()
* ----------------------------------------------------
*/
CFE_TIME_Compare_t CFE_TIME_Compare(CFE_TIME_SysTime_t TimeA, CFE_TIME_SysTime_t TimeB)
CFE_TIME_Compare_t CFE_TIME_Compare(CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_t Time2)

Check notice

Code scanning / CodeQL

Long function without assertion Note

All functions of more than 10 lines should have at least one assertion.
modules/time/fsw/src/cfe_time_api.c
@@ -452,50 +452,50 @@
* See description in header file for argument/return detail
*
*-----------------------------------------------------------------*/
CFE_TIME_Compare_t CFE_TIME_Compare(CFE_TIME_SysTime_t TimeA, CFE_TIME_SysTime_t TimeB)
CFE_TIME_Compare_t CFE_TIME_Compare(CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_t Time2)

Check notice

Code scanning / CodeQL

Long function without assertion Note

All functions of more than 10 lines should have at least one assertion.
@thnkslprpt thnkslprpt force-pushed the fix-2341-make-time1-time2-consistent branch from e7e04bf to 232e463 Compare April 19, 2024 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Inconsistent use of Time1/Time2 TimeA/TimeB parameter names
2 participants
@thnkslprpt @chillfig