HOTFIX:2021-06-15, Add missing OS_Select param doc #1073
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix usersguide doxygen warning for OS_SelectSingle and OS_SelectMultiple msecs input parameter.
skliper
approved these changes
Jun 14, 2021
|
Is there background on why this is a hotfix? It's been a while since any of this has changed, so why would it break now? Was this missing from previous documentation builds? |
|
I think the new/separate warning file perhaps made it more obvious that this was missing? |
|
Sounds like something might have been broken in CI then, maybe associated with the document building race... since the warning file was supposed to be getting checked for both users guides. |
|
Yeah, CI caught it that's why I had to fix it. I guess your question is why didn't it get caught earlier... Maybe this file wasn't being built? |
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 16, 2021
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
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>
jphickey
added a commit
to jphickey/osal
that referenced
this pull request
Aug 10, 2022
Significant refactor of many SB API calls to address inconsistencies with respect to locking and unlocking of global data structures. First this updates the definition of CFE_SB_PipeId_t to use the CFE_ES_ResourceID_t base type, and a new ID range. Notably this prevents direct access to the CFE_SB.PipeTbl global, forcing code to go through the proper lookup routine, which should only be done while locked. All API implementations follow the same general pattern: - Initial checks/queries while unlocked - Lock SB global - Lookups and/or modifications to the pipe table/routing info - Unlock SB global - Invoke other subsystems (e.g. OSAL) - Re-lock SB global (if needed) do final update, and unlock again - Send all events All error counters should be updated at the end, while still locked. All event processing is deferred to the end of each function, after all other processing is done.
jphickey
pushed a commit
to jphickey/osal
that referenced
this pull request
Aug 10, 2022
Fix nasa#1073, software bus locking
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the contribution
Fix usersguide doxygen warning for OS_SelectSingle and OS_SelectMultiple msecs input parameter.
Testing performed
Expected behavior changes
No doxygen warning
System(s) tested on
Additional context
See https://github.com/nasa/cFS/pull/265/checks?check_run_id=2798133902
Third party code
None