Skip to content

Fix #1599, documentation for FS APIs that return OSAL codes#1700

Merged
astrogeco merged 1 commit intonasa:integration-candidatefrom
jphickey:fix-1599-fs-api-doc
Jul 21, 2021
Merged

Fix #1599, documentation for FS APIs that return OSAL codes#1700
astrogeco merged 1 commit intonasa:integration-candidatefrom
jphickey:fix-1599-fs-api-doc

Conversation

@jphickey
Copy link
Contributor

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.

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.
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Jul 21, 2021
@astrogeco
Copy link
Contributor

CCB:2021-07-21 APPROVED

@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 Jul 21, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate July 21, 2021 18:08
@astrogeco astrogeco merged commit 4dee1d6 into nasa:integration-candidate Jul 21, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Jul 22, 2021
nasa/cFE#1699, correct return code check

nasa/cFE#1700, documentation for FS APIs that return OSAL codes

nasa/cFE#1695, Adding coverage tests for cfe_es_apps.c
astrogeco added a commit to nasa/cFS that referenced this pull request Jul 29, 2021
Combines:

nasa/cFE#1701, v6.8.0-rc1+dev789
nasa/osal#1116, v5.1.0-rc1+dev578
nasa/cFS-GroundSystem#192, v2.2.0-rc1+dev58

Includes:

**cFE**

nasa/cFE#1699, correct return code check
nasa/cFE#1700, documentation for FS APIs that return OSAL codes
nasa/cFE#1695, Adding coverage tests for cfe_es_apps.c
nasa/cFE#1673, Add File Utility Functional Tests.
nasa/cFE#1711, Add custom epoch support to TIME UT
nasa/cFE#1720, Requirements update for Caelum
nasa/cFE#1721, Add null check to CFE_ES_TaskID_ToIndex.
nasa/cFE#1719, scrub command documentation
nasa/cFE#1715, Add time arithmetic functional tests
nasa/cFE#1704, update docs for CFE_FS_BackgroundFileDumpRequest
nasa/cFE#1706, correct return code mismatches

**osal**

nasa/osal#1114, Add unit test branch coverage

**cFS-GroundSystem**

nasa/cFS-GroundSystem#185, Update tlm for ES Blockstats/memstats and TBL HK
nasa/cFS-GroundSystem#188, * might be referenced before assignment

Co-authored-by: Jacob Hageman <[email protected]>
Co-authored-by: Joseph Hickey <[email protected]>
Co-authored-by: Alex Campbell <[email protected]>
Co-authored-by: Jose F Martinez Pedraza <[email protected]>
Co-authored-by: Niall Mullane <[email protected]>
Co-authored-by: Paul <[email protected]>
@jphickey jphickey deleted the fix-1599-fs-api-doc branch August 3, 2021 15:19
@skliper skliper added this to the 7.0.0 milestone Sep 24, 2021
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update API/error code documentation relative to OSReturnCode cases

3 participants