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.

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 #741, Document CFE_TBL_Unregister use-case #1602

Merged

Conversation

skliper
Copy link
Contributor

@skliper skliper commented Jun 3, 2021

Describe the contribution
Fix #741 - Documents CFE_TBL_Unregister on shared table use case vs use by owning task.

Testing performed
CI - Documentation only

Expected behavior changes
None

System(s) tested on
CI

Additional context
#1509 documents potential races, global table handles often aren't protected so care needs to be taken when using shared tables.

Third party code
None

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

@skliper skliper added this to the 7.0.0 milestone Jun 3, 2021
@skliper skliper requested review from jphickey and ejtimmon June 3, 2021 20:02
@skliper skliper force-pushed the fix741-tbl_unregsiter_comments branch from 8da9a42 to d8d2b88 Compare June 3, 2021 20:08
@astrogeco astrogeco added the CCB:Approved Indicates code review and approval by community CCB label Jun 9, 2021
@astrogeco
Copy link
Contributor

CCB:2021-06-09 APPROVED

  • users should register at initialization

@astrogeco astrogeco changed the base branch from main to integration-candidate June 10, 2021 21:44
@astrogeco astrogeco added the docs This change only affects documentation. label Jun 10, 2021
@astrogeco astrogeco merged commit 474c0ff into nasa:integration-candidate Jun 10, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 10, 2021
*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

*Implement Coding Standard:*

nasa/ci_lab#87
nasa/sample_app#149
nasa/sample_lib#63
nasa/sch_lab#79
nasa/to_lab#98
nasa/cFS-GroundSystem#180
nasa/elf2cfetbl#80
nasa/tblCRCTool#48
nasa/osal#1042
nasa/PSP#292
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 <[email protected]>
Co-authored-by: Joseph Hickey <[email protected]>
Co-authored-by: Ariel Adams <[email protected]>
Co-authored-by: Alex Campbell <[email protected]>
Co-authored-by: Jose F Martinez Pedraza <[email protected]>
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 <[email protected]>
Co-authored-by: Joseph Hickey <[email protected]>
Co-authored-by: Ariel Adams <[email protected]>
Co-authored-by: Alex Campbell <[email protected]>
Co-authored-by: Jose F Martinez Pedraza <[email protected]>
@skliper skliper deleted the fix741-tbl_unregsiter_comments branch October 22, 2021 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB CCB:FastTrack docs This change only affects documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Failure during CFE_ES_ExitApp if app calls CFE_TBL_Unregister
3 participants