cFS Bundle Integration Candidate: 2021-06-01

[astrogeco]

Context

nasa/cFE#1584
nasa/osal#1058
nasa/sch_lab#82

Tests

cFS Bundle Checks https://github.com/nasa/cFS/pull/263/checks
cFE Checks https://github.com/nasa/cFE/pull/1584/checks
osal Checks https://github.com/nasa/osal/pull/1058/checks
sch_lab Checks https://github.com/nasa/sch_lab/pull/82/checks

Authors

@jphickey
@ArielSAdamsNASA
@skliper
@zanzaben
@rosspeters6

Description

Includes:

nasa/cFE#1580, Update ES verify errors to match test
nasa/cFE#1578, Resolve mismatched endforeach of CMakeList.txt
nasa/cFE#1579, Improve event filter documentation
nasa/cFE#1576, EVS/FS documentation cleanup
nasa/cFE#1575, Remove shell file subtype and clarify scope
nasa/cFE#1582, Simplify file open/truncate logic
nasa/cFE#1567, Remove deprecated elements
nasa/cFE#1556, Replace Header Content Type magic number
nasa/cFE#1553, Remove unused EVS LogMode defines
nasa/cFE#1570, Document cleanup from SB/MSG/SBR review, Remove unused CFE_SB_NO_SUBSCRIBERS
nasa/cFE#1565, Add CFE_SB_DestinationD tag and use for pointers
nasa/cFE#1564, Use CFE_MSG_SequenceCount_t for seqcnt type
nasa/cFE#1562, Document CFE_ES_PoolCreateEx NumBlockSizes error handling
nasa/cFE#1560, Documentation cleanup in TBL/TIME
nasa/cFE#1558, Document TblName as app specific
nasa/cFE#1563, use OSAL script to generate API guide
nasa/cFE#1557, Include verify headers to validate config

nasa/osal#1033, include doxygen targets locally
nasa/osal#1031, Document OS_ObjectIdToArrayIndex as public
nasa/osal#1040, resolve discrepancies between binsem API and unit tests
nasa/osal#1029, add missing clock retcode tests
nasa/osal#1046, resolve discrepancies between common API and unit tests
nasa/osal#1041, resolve discrepancies between countsem API and unit tests
nasa/osal#1045, resolve discrepancies between dir API and unit tests
nasa/osal#1043, resolve discrepancies between module API and unit tests
nasa/osal#1044, resolve discrepancies between mutex API and unit tests
nasa/osal#1038, resolve discrepancies between queue API and unit tests
nasa/osal#1037, resolve discrepancies between task API and unit tests
nasa/osal#1051, resolve discrepancies between timebase API and unit tests
nasa/osal#1030, check misc API return codes
nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job
nasa/osal#1049, filter only whole words for keyword match

nasa/osal#962, update OSAL Config Guide link

nasa/sch_lab#81, exit the main loop if init fails
nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals

[astrogeco]

@jphickey the remaining documentation error is a reference in the osalguide to the cfsversions page. Do you think we should remove that or duplicate the page on the osal repo and call it osalversions.dox or whatever?

[jphickey]

Do you think we should remove that or duplicate the page on the osal repo and call it osalversions.dox or whatever?

Option 1 - Easiest fix is to remove it, just cite that OSAL follows the same version semantics as CFE, but don't attempt to directly link to it (I think this should be valid because OSAL is a standalone product and can be used without cFE).

Option 2 - put the relevant text of cfs_versions.dox directly into the osapi-versions.h file (no separate file really needed). cFE and other cFS components can continue referencing the cfs_versions.dox, no change.

Option 3- Move the cfs_versions.dox document into OSAL, and let it live there instead, since OSAL is the actual common component.

My vote is for 1, I think its simplest.