osal Integration candidate: 2021-06-01 #1058

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

#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

astrogeco · 2021-05-27T17:23:02Z

@jphickey What do you think about renaming the doxygen warnings file to osalguide-warnings.log or even plain warnings.log?

osal/doc/src/CMakeLists.txt

Line 63 in 8e8115a

    
           file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/apiguide-warnings.log OSAL_NATIVE_LOGFILE)

…comments Fix #984, Document OS_ObjectIdToArrayIndex as public

jphickey · 2021-05-27T18:32:33Z

@jphickey What do you think about renaming the doxygen warnings file to osalguide-warnings.log or even plain warnings.log?

osal/doc/src/CMakeLists.txt

Line 63 in 8e8115a

file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/apiguide-warnings.log OSAL_NATIVE_LOGFILE)

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 osal-apiguide-warnings.log?

Fix #1023, resolve discrepancies between timer API and unit tests

#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 #1008, resolve discrepancies between binsem API and unit tests

Fix #1009, add missing clock retcode tests

Fix #1016, resolve discrepancies between module API and unit tests

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

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

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

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

astrogeco · 2021-06-03T13:19:04Z

@jphickey can you help with these doxygen errors?

https://github.com/nasa/cFS/pull/263/checks?check_run_id=2729042952 See snippet below

/home/runner/work/cFS/cFS/osal/src/os/inc/osapi-binsem.h:58: warning: Found unknown command `\nonnull'
/home/runner/work/cFS/cFS/osal/src/os/inc/osapi-binsem.h:69: warning: Found unknown command `\covtest'

jphickey · 2021-06-03T15:03:20Z

@jphickey can you help with these doxygen errors?

https://github.com/nasa/cFS/pull/263/checks?check_run_id=2729042952 See snippet below
/home/runner/work/cFS/cFS/osal/src/os/inc/osapi-binsem.h:58: warning: Found unknown command `\nonnull'
/home/runner/work/cFS/cFS/osal/src/os/inc/osapi-binsem.h:69: warning: Found unknown command `\covtest'

Hmm, it seems the CFE usersguide also includes the OSAL headers?

We might need to merge nasa/cFE#1555 after all....

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

See #1058 and nasa/cFS#263

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

The OSAL documentation should be standalone and not assume the presence of cFE or directly link to its documentation. This corrects documentation link warnings.

See #1058 and nasa/cFS#263

- #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,

- #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]>

…sions Fix nasa#1051, use OSAL time conversion/access methods

rosspeters6 and others added 19 commits April 14, 2021 10:59

Fix #961, update OSAL Config Guide link

81a9fbb

Fix #984, Document OS_ObjectIdToArrayIndex as public

652cf50

Fix #913, include doxygen targets locally

841b0f6

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 #1035, Rename CodeQL cFE and add Duplicate Job

d4af445

Fix #1009, add missing clock retcode tests

78e87f7

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.

Fix #1048, filter only whole words for keyword match

d06680e

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.

Fix #1048, also filter C++-style comments

e8add95

Truncate input lines at C++-style comment markers, in case users/projects allow this style of comment.

Fix #1008, resolve discrepancies between binsem API and unit tests

5ca529b

Ensures correlation between the unit-tests and documented return values for the OSAL binsem API.

Fix #1010, resolve discrepancies between common API and unit tests

c831aeb

Ensures correlation between the unit-tests and documented return values for the OSAL common API.

Fix #1011, resolve discrepancies between countsem API and unit tests

715501d

Ensures correlation between the unit-tests and documented return values for the OSAL countsem API.

Fix #1012, resolve discrepancies between dir API and unit tests

92e56e6

Ensures correlation between the unit-tests and documented return values for the OSAL directory API.

Fix #1017, resolve discrepancies between mutex API and unit tests

40b4a89

Ensures correlation between the unit-tests and documented return values for the OSAL mutex API.

Fix #1018, resolve discrepancies between queue API and unit tests

fce66b5

Ensures correlation between the unit-tests and documented return values for the OSAL queue API.

Fix #1022, resolve discrepancies between timebase API and unit tests

fc0482b

Ensures correlation between the test cases and documented return values for the OSAL timebase API.

Fix #1023, resolve discrepancies between timer API and unit tests

1e0025b

Ensures correlation between the test cases and documented return values for the OSAL timer API.

Merge pull request #1033 from jphickey/fix-913-localize-doxygen

8e8115a

Fix #913, include doxygen targets locally

astrogeco added a commit to nasa/cFS that referenced this pull request May 27, 2021

IC:2021-06-01, osalguide doxygen migration

e9f8501

#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

astrogeco mentioned this pull request May 27, 2021

cFS Bundle Integration Candidate: 2021-06-01 nasa/cFS#263

Merged

Merge pull request #1031 from skliper/fix984-os_objectidtoarrayindex_…

5edc586

…comments Fix #984, Document OS_ObjectIdToArrayIndex as public

jphickey and others added 2 commits May 28, 2021 11:22

HOTFIX IC 2021-06-01, update osal apiguide warning filename

a72eeb9

Merge pull request #1053 from jphickey/fix-1023-timer-api-retcodes

b041927

Fix #1023, resolve discrepancies between timer API and unit tests

astrogeco added the IC:2021-06-01 label Jun 1, 2021

astrogeco added a commit to nasa/cFS that referenced this pull request Jun 1, 2021

IC:2021-06-01, osalguide doxygen migration

7a93613

#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

astrogeco added 2 commits June 1, 2021 13:09

Merge pull request #1040 from jphickey/fix-1008-binsem-api-retcodes

d5c8fc4

Fix #1008, resolve discrepancies between binsem API and unit tests

Merge pull request #1029 from jphickey/fix-1009-clock-retcodes

b6511e9

Fix #1009, add missing clock retcode tests

Merge pull request #1043 from jphickey/fix-1016-module-api-retcodes

976d1fa

Fix #1016, resolve discrepancies between module API and unit tests

astrogeco added 7 commits June 1, 2021 13:54

Merge pull request #1044 from jphickey/fix-1017-mutex-api-retcodes

0c8dbe0

Fix #1017, resolve discrepancies between mutex API and unit tests

Merge pull request #1038 from jphickey/fix-1018-queue-api-retcodes

b339de0

Fix #1018, resolve discrepancies between queue API and unit tests

Merge pull request #1037 from jphickey/fix-1021-task-api-retcodes

f3c3692

Fix #1021, resolve discrepancies between task API and unit tests

Merge pull request #1051 from jphickey/fix-1022-timebase-api-retcodes

494f2f4

Fix #1022, resolve discrepancies between timebase API and unit tests

Merge pull request #1030 from jphickey/fix-1024-api-test-retcodes

36a2923

Fix #1024, check misc API return codes

Merge pull request #1039 from ArielSAdamsNASA/fix-1035-rename-cfe-dup…

d57e3d6

…licate Fix #1035, Rename CodeQL cFE Build and add Duplicate Job

Merge pull request #1049 from jphickey/fix-1048-extern-strings

d5d370a

Fix #1048, filter only whole words for keyword match

Merge pull request #962 from rosspeters6/fix-961-update-osal-config-g…

269e6c1

…uide-link Fix #961, update OSAL Config Guide link

astrogeco added the community label Jun 2, 2021

astrogeco added a commit to nasa/cFS that referenced this pull request Jun 2, 2021

IC:2021-06-01, Add cFE PRs and osal community PR

c5f3766

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

astrogeco marked this pull request as ready for review June 8, 2021 17:05

astrogeco added a commit that referenced this pull request Jun 8, 2021

IC:2021-06-01, Bump to v5.1.0-rc1+dev500

8d8d55c

See #1058 and nasa/cFS#263

astrogeco added a commit to nasa/cFS that referenced this pull request Jun 8, 2021

IC:2021-06-01, Add version bumps

72fab36

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 June 8, 2021 17:49

jphickey and others added 2 commits June 8, 2021 13:56

HOTFIX 2021-06-01: Update cFS version doxygen refs

b210b27

The OSAL documentation should be standalone and not assume the presence of cFE or directly link to its documentation. This corrects documentation link warnings.

IC:2021-06-01, Bump to v5.1.0-rc1+dev501

4e377ef

See #1058 and nasa/cFS#263

astrogeco force-pushed the integration-candidate branch from e48d2dd to 4e377ef Compare June 8, 2021 17:58

astrogeco merged commit c540688 into main Jun 8, 2021

skliper added this to the 6.0.0 milestone Sep 24, 2021

jphickey pushed a commit to jphickey/osal that referenced this pull request Aug 10, 2022

Merge pull request nasa#1058 from jphickey/fix-1051-use-ostime-conver…

49da2bd

…sions Fix nasa#1051, use OSAL time conversion/access methods

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

osal Integration candidate: 2021-06-01 #1058

osal Integration candidate: 2021-06-01 #1058

astrogeco commented May 27, 2021 •

edited

Loading

astrogeco commented May 27, 2021 •

edited

Loading

jphickey commented May 27, 2021

astrogeco commented Jun 3, 2021

jphickey commented Jun 3, 2021

osal Integration candidate: 2021-06-01 #1058

osal Integration candidate: 2021-06-01 #1058

Conversation

astrogeco commented May 27, 2021 • edited Loading

Context

Tests

Authors

Description

PR #1033

PR #1053

PR #1040

PR #1029

PR #1046

PR #1041

PR #1045

PR #1043

PR #1044

PR #1038

PR #1037

PR #1051

PR #1030

PR #1039

PR #1049

PR #962

astrogeco commented May 27, 2021 • edited Loading

jphickey commented May 27, 2021

astrogeco commented Jun 3, 2021

jphickey commented Jun 3, 2021

astrogeco commented May 27, 2021 •

edited

Loading

astrogeco commented May 27, 2021 •

edited

Loading