Fix #1942, add missing inclusions in CFE API headers #1943
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
Some CFE API headers were missing dependency inclusions, where the header was referencing a type or symbol but not directly including the header file that provides that type/symbol. Adding the dependent include allows the headers to work more consistently.
jphickey
added
the
CCB:Ready
|
This is the type of stuff I'd suggest to queue up for a "caelum.1" release ... given that caelum is already tagged or soon to be. probably will continue to slowly find other gotchas as the code is used for more stuff by more users. |
|
Is there a way to enforce the "headercheck" concept in CI? |
zanzaben
approved these changes
Sep 10, 2021
skliper
approved these changes
Sep 13, 2021
astrogeco
added
CCB:Approved
|
CCB:2021-09-15 APPROVED
|
|
@skliper can we move this to Caelum? |
|
@astrogeco Absolutely! Moved to Caelum. |
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Sep 21, 2021
2 tasks
astrogeco
added a commit
to astrogeco/cFS
that referenced
this pull request
Sep 22, 2021
**Combines** nasa/cFE#1967 v6.8.0-rc1+dev1024 nasa/osal#1158 v5.1.0-rc1+dev619 nasa/sch_lab#92 v2.4.0-rc1+dev53 nasa/sample_app#155 v1.2.0-rc1+dev73 nasa/to_lab#105 v2.4.0-rc1+dev58 nasa/ci_lab#93 v2.4.0-rc1+dev46 **Includes:** *cFE* nasa/cFE#1948, Update name of macros/functions added to "cfe_assert" nasa/cFE#1950, Fix Mismatch between MSG API and test case in "TestMsgId" functional test nasa/cFE#1962, Single time domain in functional time tests nasa/cFE#1943, add missing inclusions in CFE API headers nasa/cFE#1964, Use existing /ram for FS header test nasa/cFE#1956, Add static local to function test so data section is nonzero nasa/cFE#1960, Make invalid buffer length consistent in es task test nasa/cFE#1953, Only check base filename in library info functional nasa/cFE#1970, Confirm sb/time reset requirements in coverage test nasa/cFE#1947, Fix broken link in App Developers Guide nasa/cFE#1972, Fix #1971, avoid alias warning on some compilers *osal* nas/osal#1149, Enable symbol api test and MIR dump too large nasa/osal#1152, Fix OSAL loader test hard fails if size exceeded nasa/osal#1155, add bsp-specific configuration flag registry nasa/osal#1157, Add os-specifc socket flag function *Apps* nasa/ci_lab#92, Apply CFE_SB_ValueToMsgId where required nasa/sample_app#154, Apply CFE_SB_ValueToMsgId where required nasa/sch_lab#91, Apply CFE_SB_ValueToMsgId where required nasa/to_lab#104, Apply CFE_SB_ValueToMsgId where required Co-authored-by: Jacob Hageman <skliper@users.noreply.github.com> Co-authored-by: Joseph Hickey <jphickey@users.noreply.github.com> Co-authored-by: Adrien Chardon <nodraak@users.noreply.github.com>
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Sep 22, 2021
**Combines** nasa/cFE#1967 v6.8.0-rc1+dev1024 nasa/osal#1158 v5.1.0-rc1+dev619 nasa/sch_lab#92 v2.4.0-rc1+dev53 nasa/sample_app#155 v1.2.0-rc1+dev73 nasa/to_lab#105 v2.4.0-rc1+dev58 nasa/ci_lab#93 v2.4.0-rc1+dev46 **Includes:** *cFE* nasa/cFE#1948, Update name of macros/functions added to "cfe_assert" nasa/cFE#1950, Fix Mismatch between MSG API and test case in "TestMsgId" functional test nasa/cFE#1962, Single time domain in functional time tests nasa/cFE#1943, add missing inclusions in CFE API headers nasa/cFE#1964, Use existing /ram for FS header test nasa/cFE#1956, Add static local to function test so data section is nonzero nasa/cFE#1960, Make invalid buffer length consistent in es task test nasa/cFE#1953, Only check base filename in library info functional nasa/cFE#1970, Confirm sb/time reset requirements in coverage test nasa/cFE#1947, Fix broken link in App Developers Guide nasa/cFE#1972, Fix #1971, avoid alias warning on some compilers *osal* nas/osal#1149, Enable symbol api test and MIR dump too large nasa/osal#1152, Fix OSAL loader test hard fails if size exceeded nasa/osal#1155, add bsp-specific configuration flag registry nasa/osal#1157, Add os-specifc socket flag function *Apps* nasa/ci_lab#92, Apply CFE_SB_ValueToMsgId where required nasa/sample_app#154, Apply CFE_SB_ValueToMsgId where required nasa/sch_lab#91, Apply CFE_SB_ValueToMsgId where required nasa/to_lab#104, Apply CFE_SB_ValueToMsgId where required Co-authored-by: Jacob Hageman <skliper@users.noreply.github.com> Co-authored-by: Joseph Hickey <jphickey@users.noreply.github.com> Co-authored-by: Adrien Chardon <nodraak@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
Some CFE API headers were missing dependency inclusions, where the header was referencing a type or symbol but not directly including the header file that provides that type/symbol.
Adding the dependent include allows the headers to work more consistently.
Fixes #1942
Testing performed
Build and sanity check CFE
Expected behavior changes
None for framework config (these inclusions were already satisfied in existing use cases)
But fixes a broken build for external code that only included these headers directly.
System(s) tested on
Ubuntu
Additional context
This type of thing was intended to be caught by the "headercheck" concept in the module code, but that is currently not enabled/enforced in the build.
There theoretically could be other instances of stuff like this, but these are the only two noted so far.
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.