Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix #1604, Clean/simplify version header and reporting #1605

Merged

Conversation

skliper
Copy link
Contributor

@skliper skliper commented Jun 3, 2021

Describe the contribution
Fix #1604 - cleans up the version header and how it's reported (standardized event text). Note just ES uses/reports the short version.

Testing performed
Built and ran unit tests, executed cfe to confirm output.

Expected behavior changes
Minor event message output format changes

System(s) tested on

  • Hardware: Intel I5/Docker
  • OS: Ubuntu 18.04
  • Versions: Bundle main + this commit

Additional context
#1603

Third party code
None

Contributor Info - All information REQUIRED for consideration of pull request
Jacob Hageman - NASA/GSFC

@skliper skliper added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Jun 3, 2021
@skliper skliper added this to the 7.0.0 milestone Jun 3, 2021
@skliper skliper requested review from jphickey and astrogeco June 3, 2021 22:48
Copy link
Contributor

@jphickey jphickey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My only concern is regarding the "build number" being a string rather than an integer. I do like the simplicity, but for OSAL and PSP we now expose the build info via API call, and the OS_GetBuildNumber function and CFE_PSP_GetBuildNumber function are both defined as returning uint32 values.

Ideally, the long version strings should be assembled at runtime from raw material available via API calls (short version string + code name + official release version + build number). This shouldn't be separately defined.

But for the time being if we at least keep the build number as numeric, the same general pattern/info can exist for OSAL + PSP + CFE without fundamentally changing the others.

@skliper skliper force-pushed the fix1604-version_h_cleanup branch from 1ce058e to 31be7d9 Compare June 7, 2021 13:00
@skliper skliper requested a review from jphickey June 7, 2021 13:02
@skliper
Copy link
Contributor Author

skliper commented Jun 7, 2021

Converted back to integer build number

@astrogeco astrogeco added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels Jun 9, 2021
@astrogeco
Copy link
Contributor

astrogeco commented Jun 9, 2021

CCB:2021-06-09 APPROVED

  • If we like the new event format we can make it consistent across components

@skliper skliper force-pushed the fix1604-version_h_cleanup branch from 31be7d9 to 0cd0eba Compare June 15, 2021 15:47
@skliper
Copy link
Contributor Author

skliper commented Jun 15, 2021

@astrogeco - fixed conflict

@skliper skliper removed the conflicts label Jun 15, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate June 15, 2021 15:49
@astrogeco astrogeco merged commit 5d2288a into nasa:integration-candidate Jun 15, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 16, 2021
nasa/cFE#1600, Add workflow to build cFE documentation

nasa/cFE#1609, Requirements updates

nasa/cFE#1610, ES/ResourceID documentation cleanup

nasa/cFE#1613, allow multiple sources in add_cfe_coverage_test

nasa/cFE#1586, add ES Misc Functional test

nasa/cFE#1607, add Mempool functional tests

nasa/cFE#1605, Clean/simplify version header and reporting

nasa/cFE#1612, 1589, doxygen cleanup

nasa/cFE#1611, Prepend system log messages with function name
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 17, 2021
nasa/cFE#1619 - cfe v6.8.0-rc1+dev693
nasa/osal#1076 - osal v5.1.0-rc1+dev530
nasa/PSP#296 - psp v1.5.0-rc1+dev118

*Documentation Updates:*

nasa/cFE#1598, Updated FS Read/WriteHeader API return documentation
nasa/cFE#1601, Document CFE_ES_RunLoop increment task counter behavior
nasa/cFE#1602, Document CFE_TBL_Unregister use-case
nasa/cFE#1603, Update version description per current design

*Standardize docs generation:*

nasa/cFE#1615, standardize on "docs" subdirectory
nasa/osal#1071, rename doc to docs
nasa/PSP#294, rename doc to docs

*Coding Standard:*

nasa/osal#1042
nasa/PSP#292

**Mutex for UTAssert**

nasa/cFE#1596, provide CFE assert lock/unlock
nasa/osal#1065, add mutex lock around UtAssert globals

*Resolve API-UT discrepancies:*

nasa/osal#1055, idmap API
nasa/osal#1056, file API
nasa/osal#1057, filesys API
nasa/osal#1060, socket API
nasa/osal#1064, select API

**Other cFE ixes**

nasa/cFE#1566, Simplify CFE_FS_SetTimestamp and fix syslog typo
nasa/cFE#1592, Removed redundant check/set of CFE_CPU_ID_VALUE
nasa/cFE#1593, add time get reference error bit
nasa/cFE#1600, Add workflow to build cFE documentation
nasa/cFE#1609, Requirements updates
nasa/cFE#1610, ES/ResourceID documentation cleanup
nasa/cFE#1613, allow multiple sources in add_cfe_coverage_test
nasa/cFE#1586, add ES Misc Functional test
nasa/cFE#1607, add Mempool functional tests
nasa/cFE#1605, Clean/simplify version header and reporting
nasa/cFE#1612, doxygen cleanup
nasa/cFE#1611, Prepend system log messages with function name

nasa/osal#1063, const correct OS_SelectFdIsSet
nasa/osal#1073, Fix OS_Select doxygen errors
nasa/osal#1073, Add missing OS_Select param doc
nasa/osal#1067, Add Workflow to build and verify OSAL API Guide
nasa/osal#1070, add detail design template
nasa/osal#1072, Update error codes and documentation
nasa/osal#1075, Increase UT object limit for testing

Co-authored-by: Jacob Hageman <skliper@users.noreply.github.com>
Co-authored-by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored-by: Ariel Adams <ArielSAdamsNASA@users.noreply.github.com>
Co-authored-by: Alex Campbell <zanzaben@users.noreply.github.com>
Co-authored-by: Jose F Martinez Pedraza <pepepr08@users.noreply.github.com>
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 17, 2021
nasa/cFE#1619 - cfe v6.8.0-rc1+dev693
nasa/osal#1076 - osal v5.1.0-rc1+dev530
nasa/PSP#296 - psp v1.5.0-rc1+dev118

*Documentation Updates:*

nasa/cFE#1598, Updated FS Read/WriteHeader API return documentation
nasa/cFE#1601, Document CFE_ES_RunLoop increment task counter behavior
nasa/cFE#1602, Document CFE_TBL_Unregister use-case
nasa/cFE#1603, Update version description per current design

*Standardize docs generation:*

nasa/cFE#1615, standardize on "docs" subdirectory
nasa/osal#1071, rename doc to docs
nasa/PSP#294, rename doc to docs

*Coding Standard:*

nasa/osal#1042
nasa/PSP#292

**Mutex for UTAssert**

nasa/cFE#1596, provide CFE assert lock/unlock
nasa/osal#1065, add mutex lock around UtAssert globals

*Resolve API-UT discrepancies:*

nasa/osal#1055, idmap API
nasa/osal#1056, file API
nasa/osal#1057, filesys API
nasa/osal#1060, socket API
nasa/osal#1064, select API

**Other cFE Fixes**

nasa/cFE#1566, Simplify CFE_FS_SetTimestamp and fix syslog typo
nasa/cFE#1592, Removed redundant check/set of CFE_CPU_ID_VALUE
nasa/cFE#1593, add time get reference error bit
nasa/cFE#1600, Add workflow to build cFE documentation
nasa/cFE#1609, Requirements updates
nasa/cFE#1610, ES/ResourceID documentation cleanup
nasa/cFE#1613, allow multiple sources in add_cfe_coverage_test
nasa/cFE#1586, add ES Misc Functional test
nasa/cFE#1607, add Mempool functional tests
nasa/cFE#1605, Clean/simplify version header and reporting
nasa/cFE#1612, doxygen cleanup
nasa/cFE#1611, Prepend system log messages with function name

**Other osal Fixes**

nasa/osal#1063, const correct OS_SelectFdIsSet
nasa/osal#1073, Fix OS_Select doxygen errors
nasa/osal#1073, Add missing OS_Select param doc
nasa/osal#1067, Add Workflow to build and verify OSAL API Guide
nasa/osal#1070, add detail design template
nasa/osal#1072, Update error codes and documentation
nasa/osal#1075, Increase UT object limit for testing

Co-authored-by: Jacob Hageman <skliper@users.noreply.github.com>
Co-authored-by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored-by: Ariel Adams <ArielSAdamsNASA@users.noreply.github.com>
Co-authored-by: Alex Campbell <zanzaben@users.noreply.github.com>
Co-authored-by: Jose F Martinez Pedraza <pepepr08@users.noreply.github.com>
@skliper skliper deleted the fix1604-version_h_cleanup branch October 22, 2021 19:25
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
CCB:Approved Indicates code review and approval by community CCB
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clean up version header and standardize reporting
3 participants