Fix #1561, use OSAL script to generate API guide #1563
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
Instead of including the OSAL API guide templates and pages in the CFE repo, invoke the build script now provided in the OSAL repo itself.
jphickey
added
the
CCB:Ready
|
Note for review/merge, the codeQL build failure is due to the missing dependency from nasa/osal#913 ... once this is merged into the baseline, this PR works fine. |
skliper
approved these changes
May 20, 2021
astrogeco
added
CCB:Approved
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
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
This was referenced Jun 2, 2021
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 <jphickey@users.noreply.github.com> Co-authored-by: Jake Hageman skliper <skliper@users.noreply.github.com> Co-authored-by: Alex Campbell <zanzaben@users.noreply.github.com> Co-authored-by: Ariel Adams <ArielSAdamsNASA@users.noreply.github.com> Co-authored-by: Ross Peters <rosspeters6@users.noreply.github.com>
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.
Describe the contribution
Instead of including the OSAL API guide templates and pages in the CFE repo, invoke the build script now provided in
the OSAL repo itself.
Fixes #1561
Testing performed
Build full documentation, including OSAL API guide, confirm same as it was
Expected behavior changes
None, documentation build only
System(s) tested on
Ubuntu
Additional context
Depends on nasa/osal#1033
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.