osal Integration candidate: 2021-06-01 #1058
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
Add the "doxyfile" templates and various OSAL doxygen pages locally under the "doc/src" directory. Add a CMake script to build the documentation in either a standalone or integrated build environment.
Fix missing doxygen retvals Note, other tests were OK, but depend on support being enabled and supported by RTOS. Script will report N/A items (due to no impl) as missing. Confirmed OS_HeapGetInfo OK on RTEMS. For test cases where a function is invoked before OS_API_Init, only check that the result is not success. This will remain as "undocumented" behavior - users should not call functions before init, because it is not valid to do so. A specific error code is not guaranteed here.
Note that the success case for OS_SetLocalTime is tested, but is marked as a MIR test case because it requires elevated permission, it is expected to fail when running as a normal user on Linux.
In the stub generator script, filter only whole words when ignoring keywords. Do not match if the word appears as a substring inside a larger word.
Truncate input lines at C++-style comment markers, in case users/projects allow this style of comment.
Ensures correlation between the unit-tests and documented return values for the OSAL binsem API.
Ensures correlation between the unit-tests and documented return values for the OSAL common API.
Ensures correlation between the unit-tests and documented return values for the OSAL countsem API.
Ensures correlation between the unit-tests and documented return values for the OSAL directory API.
Ensures correlation between the unit-tests and documented return values for the OSAL module API. Adds documentation for OS_ERR_OUTPUT_TOO_LARGE and OS_ERR_NAME_TOO_LONG. These are primarily validated via coverage test, as symbol table dump is only possible on VxWorks. Move the test for OS_INVALID_POINTER to after setup, where the module ID is valid.
Ensures correlation between the unit-tests and documented return values for the OSAL mutex API.
Ensures correlation between the unit-tests and documented return values for the OSAL queue API.
Ensures correlation between the unit-tests and documented return values for the OSAL task API. Also adds the following test cases: - Call OS_TaskCreate with a NULL stack pointer - Confirm OS_TaskDeleteHandler function was invoked - Confirm OS_TaskDelay interval
Ensures correlation between the test cases and documented return values for the OSAL timebase API.
Ensures correlation between the test cases and documented return values for the OSAL timer API.
Fix #913, include doxygen targets locally
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
May 27, 2021
#263 Combines nasa/cFE#1584 nasa/osal#1058 Includes: nasa/cFE#1563, use OSAL script to generate API guide nasa/osal#1033, include doxygen targets locally
…comments Fix #984, Document OS_ObjectIdToArrayIndex as public
The idea is that there could be some form of OSAL detail design in addition to the API guide like CFE has. That's why the targets use an "apiguide' qualifier - I want to keep the target/output files qualified with something in case we introduce more OSAL doc targets in the future. How about |
Fix #1023, resolve discrepancies between timer API and unit tests
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 1, 2021
#263 Combines nasa/cFE#1584 nasa/osal#1058 Includes: nasa/cFE#1563, use OSAL script to generate API guide nasa/osal#1033, include doxygen targets locally
Fix #1016, resolve discrepancies between module API and unit tests
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 1, 2021
Update nasa/osal#1058 Includes: 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
Fix #1017, resolve discrepancies between mutex API and unit tests
Fix #1018, resolve discrepancies between queue API and unit tests
Fix #1021, resolve discrepancies between task API and unit tests
Fix #1022, resolve discrepancies between timebase API and unit tests
Fix #1024, check misc API return codes
…licate Fix #1035, Rename CodeQL cFE Build and add Duplicate Job
Fix #1048, filter only whole words for keyword match
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 2, 2021
Update nasa/osal#1058 Includes: 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
…uide-link Fix #961, update OSAL Config Guide link
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 2, 2021
Update nasa/osal#1058 Includes: 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
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 2, 2021
Updates nasa/cFE#1584 and nasa/osal#1058 Includes nasa/osal#962, update OSAL Config Guide link nasa/cFE#1557, Include verify headers to validate config
|
@jphickey can you help with these doxygen errors? https://github.com/nasa/cFS/pull/263/checks?check_run_id=2729042952 See snippet below |
Hmm, it seems the CFE usersguide also includes the OSAL headers? We might need to merge nasa/cFE#1555 after all.... |
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 4, 2021
Combines: nasa/osal#1058 nasa/cFE#1584 nasa/sch_lab#82 Includes: nasa/sch_lab#81, exit the main loop if init fails nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals nasa/osal HOTFIX
astrogeco
added a commit
that referenced
this pull request
Jun 8, 2021
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 8, 2021
nasa/cFE#1584 v6.8.0-rc1+dev642 nasa/osal#1058 v5.1.0-rc1+dev500 nasa/sch_lab#82 v2.4.0-rc1+dev36
jphickey
force-pushed
the
integration-candidate
branch
2 times, most recently
from
0ace283 to
e48d2dd
Compare
The OSAL documentation should be standalone and not assume the presence of cFE or directly link to its documentation. This corrects documentation link warnings.
astrogeco
force-pushed
the
integration-candidate
branch
from
e48d2dd to
4e377ef
Compare
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 8, 2021
- #263, bundle Combines: - nasa/cFE#1584, v6.8.0-rc1+dev642 - nasa/osal#1058, v5.1.0-rc1+dev500 - nasa/sch_lab#82, v2.4.0-rc1+dev36 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/cFE#1555, add doxygen aliases for OSAL parameter/retvals - 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 - HOTFIX cFS-bundle, Use new osalguide logfile to fix documentation build workflow errors,
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jun 8, 2021
- #263, bundle Combines: - nasa/cFE#1584, v6.8.0-rc1+dev642 - nasa/osal#1058, v5.1.0-rc1+dev500 - nasa/sch_lab#82, v2.4.0-rc1+dev36 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/cFE#1555, add doxygen aliases for OSAL parameter/retvals - 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 - HOTFIX cFS-bundle, Use new osalguide logfile to fix documentation build workflow errors, Co-authored-by: Joseph Hickey <[email protected]> Co-authored-by: Jake Hageman skliper <[email protected]> Co-authored-by: Alex Campbell <[email protected]> Co-authored-by: Ariel Adams <[email protected]> Co-authored-by: Ross Peters <[email protected]>
jphickey
pushed a commit
to jphickey/osal
that referenced
this pull request
Aug 10, 2022
…sions Fix nasa#1051, use OSAL time conversion/access methods
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.
Context
Part of nasa/cFS#263
Tests
osal Checks https://github.com/nasa/osal/pull/1058/checks
cFS Bundle Checks https://github.com/nasa/cFS/pull/263/checks
Authors
@jphickey
@ArielSAdamsNASA
@rosspeters6
@skliper
Description
PR #1033
Fix #913, include doxygen targets locally
PR #1053
Fix #1023, resolve discrepancies between timer API and unit tests
Ensures correlation between the test cases and documented return values for the OSAL timer API.
PR #1040
Fix #1008, resolve discrepancies between binsem API and unit tests
PR #1029
Fix #1009, add missing clock retcode tests
PR #1046
Fix #1010, resolve discrepancies between common API and unit tests
PR #1041
Fix #1011, resolve discrepancies between countsem API and unit tests
PR #1045
Fix #1012, resolve discrepancies between dir API and unit tests
PR #1043
Fix #1016, resolve discrepancies between module API and unit tests
PR #1044
Fix #1017, resolve discrepancies between mutex API and unit tests
PR #1038
Fix #1018, resolve discrepancies between queue API and unit tests
PR #1037
Fix #1021, resolve discrepancies between task API and unit tests
PR #1051
Fix #1022, resolve discrepancies between timebase API and unit tests
PR #1030
Fix #1024, check misc API return codes
PR #1039
Fix #1035, Rename CodeQL cFE Build and add Duplicate Job
PR #1049
Fix #1048, filter only whole words for keyword match
PR #962
Fix #961, update OSAL Config Guide link