Fix #1599, documentation for FS APIs that return OSAL codes #1700
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
Some FS API calls will pass through failure/status codes directly from OSAL without remapping to CFE Status code values.
Note this behavior in the documentation and that it will likely change in a future version of CFE.
Fixes #1599
Testing performed
Build and sanity check CFE, build docs
Expected behavior changes
None (docs only)
System(s) tested on
Ubuntu
Additional context
This just documents the pass through - Behavior should be fixed in #1676 to return a proper CFE status.
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.