Fix #1299, Updated FS Read/WriteHeader API return documentation #1598
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
zanzaben
previously requested changes
Jun 3, 2021
See #1599, will address generally as part of that resolution. |
zanzaben
approved these changes
Jun 3, 2021
jphickey
approved these changes
Jun 3, 2021
There was a problem hiding this comment.
Only minor nitpick is that the documentation doesn't say what "success" is. There is still only one "success" return value to expect here, except it is sizeof(CFE_FS_Header_t) instead of CFE_SUCCESS.
I'm not sure its worth changing though, because in the next version I'd rather fix this to return CFE_SUCCESS like everything else does, rather than continuing to return a size.
|
CCB:2021-06-09 APPROVED
|
astrogeco
added
the
CCB:Approved
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
This was referenced Jun 10, 2021
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>
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 #1299 - updated return documentation for CFE_FS_ReadHeader and CFE_FS_WriteHeader to state they return bytes read/written or error code. Left as CFE_Status_t since they do return error codes, although overloaded. It is confusing since 0 actually indicates the data wasn't read or written, but that would require an API change. Related issue is #483.
Testing performed
CI - documentation only
Expected behavior changes
None, documentation only
System(s) tested on
CI
Additional context
None
Third party code
None
Contributor Info - All information REQUIRED for consideration of pull request
Jacob Hageman - NASA/GSFC