Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #2320, reorganize headers #2321

Merged
merged 11 commits into from
May 4, 2023
Merged

Conversation

jphickey
Copy link
Contributor

@jphickey jphickey commented May 3, 2023

Checklist (Please check before submitting)

Describe the contribution
Reorganizes all the headers in CFE to make them comply with the naming convention as described in the developers guide section 4.2.

Fixes #2320

Testing performed
Build and sanity check CFE in a variety of configurations

Expected behavior changes
Header files are split into smaller parts, more manageable.
Should be backward compatible...

System(s) tested on
Debian

Additional context
The smaller, more granular header files are not only easier to maintain (if maintained by hand) but also are more easily switched to a generated source. It is important to compartmentalize the contents because "source switching" will not work if different types of definitions are mixed in the same header.

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

@jphickey
Copy link
Contributor Author

jphickey commented May 3, 2023

Notably -- with this change, the build system no longer requires the user to maintain a cloned-and-owned copy of the config files in their "defs" directory (e.g. mission_cfg, platform_cfg, etc). The source selection is in place and it will use the supplied default version if no override is given. However, if any override is already present, it will still be used (thus preserving existing configs)

@jphickey jphickey force-pushed the fix-2320-reorganize-headers branch 2 times, most recently from 8578200 to 06c4bea Compare May 4, 2023 13:43
** mixed-endian environments. This will become obsolete once EDS is
** available and the CFE time tone message is defined.
*/
#undef CFE_PLATFORM_TIME_CFG_BIGENDIAN

Check notice

Code scanning / CodeQL

Use of #undef

The #undef directive shall not be used.
** mixed-endian environments. This will become obsolete once EDS is
** available and the CFE time tone message is defined.
*/
#undef CFE_PLATFORM_TIME_CFG_BIGENDIAN

Check notice

Code scanning / CodeQL

Disallowed preprocessor use

This preprocessor directive is not allowed.
Organize ES header file contents according to the convention
Organize SB header file contents according to the convention
Organize TBL header file contents according to the convention
Organize TIME header file contents according to the convention
Organize EVS header file contents according to the convention
Organize FS header file contents according to the convention
Organize CORE_API header file contents according to the convention
Organize CORE_PRIVATE header file contents according to the convention
@jphickey jphickey force-pushed the fix-2320-reorganize-headers branch from 06c4bea to eea6877 Compare May 4, 2023 14:14
Organize CFE_TESTCASE header file contents according to the convention
Corrects the paths and references in the documentation build to reflect
the header name changes.

Removes the overrides from "sample_defs" as these are no longer strictly
required, user only needs to override if they really need to change
something.
@jphickey jphickey force-pushed the fix-2320-reorganize-headers branch from eea6877 to 4bff797 Compare May 4, 2023 14:24
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label May 4, 2023
@dzbaker dzbaker added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels May 4, 2023
dzbaker added a commit that referenced this pull request May 4, 2023
dzbaker added a commit to nasa/cFS that referenced this pull request May 4, 2023
*Combines:*

cFE v7.0.0-rc4+dev304

**Includes:**

*cFE*
- nasa/cFE#2321
- nasa/cFE#2214
- nasa/cFE#2319

Co-authored by: Joseph Hickey <[email protected]>
This is an optional component and thus may not be part of the build.
Hotfix based on workflow testing.
@jphickey jphickey force-pushed the fix-2320-reorganize-headers branch from e89f426 to ca5106f Compare May 4, 2023 20:52
dzbaker added a commit to nasa/cFS that referenced this pull request May 4, 2023
*Combines:*

cFE v7.0.0-rc4+dev304

**Includes:**

*cFE*
- nasa/cFE#2321
- nasa/cFE#2214
- nasa/cFE#2319

Co-authored by: Joseph Hickey <[email protected]>
dzbaker added a commit to nasa/cFS that referenced this pull request May 4, 2023
*Combines:*

cFE v7.0.0-rc4+dev304

**Includes:**

*cFE*
- nasa/cFE#2321
- nasa/cFE#2214
- nasa/cFE#2319

Co-authored by: Joseph Hickey <[email protected]>
@dzbaker dzbaker merged commit 00ff6da into nasa:main May 4, 2023
dzbaker added a commit to nasa/cFS that referenced this pull request May 4, 2023
*Combines:*

cFE v7.0.0-rc4+dev304

**Includes:**

*cFE*
- nasa/cFE#2321
- nasa/cFE#2214
- nasa/cFE#2319

Co-authored by: Joseph Hickey <[email protected]>
@dmknutsen dmknutsen added this to the Equuleus milestone May 26, 2023
@jphickey jphickey deleted the fix-2320-reorganize-headers branch May 31, 2023 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB Equuleus-rc1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorganize include files for CFE
3 participants