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.

Sign up for GitHub

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

Jump to bottom

Reorganize include files for CFE #2320

Closed

jphickey opened this issue May 2, 2023 · 0 comments · Fixed by #2321

Assignees

Labels

enhancement Equuleus-rc1

Milestone

Contributor

jphickey commented May 2, 2023

Is your feature request related to a problem? Please describe.
A recommendation for header file naming and scoping was documented in #2305 and PR #2306. However, that PR was just a document, CFE itself does not (yet) adhere to this convention

Describe the solution you'd like
Split the current "cfe_mission_cfg.h" and "cfe_platform_cfg.h" into module-specific chunks (es, sb, evs, tbl, time). And organize the names and contents of those chunks according to the documented convention in https://github.com/nasa/cFE/blob/main/docs/cFE%20Application%20Developers%20Guide.md#421-cfs-application-template

Describe alternatives you've considered
N/A

Additional context
This is important going forward as some files (in particular, those that define the interfaces) may be generated from a tool. It is therefore important to separate the file content according to the convention. This allows headers that are generated by the tool to be "source-selected" accordingly; we do not want to have those definitions mixed with other types of unrelated definitions.

Currently, the CFE platform and mission config files contain a mixture of definitions - all of the core apps are mixed together, and some of the definitions affect the interfaces, and some do not.

Requester Info
Joseph Hickey, Vantage Systems, Inc.

jphickey self-assigned this

jphickey added the enhancement label

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize ES header files

d985aee

Organize ES header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize SB header files

86cbe6a

Organize SB header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize TBL header files

cec6e36

Organize TBL header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize TIME header files

a3feabc

Organize TIME header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize EVS header files

8f4d8d9

Organize EVS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize FS header files

e63a5ea

Organize FS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_API header files

ee590e3

Organize CORE_API header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_PRIVATE header files

48bacc2

Organize CORE_PRIVATE header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, clean up sample_defs to match

4c3a9ba

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize ES header files

ca1cf87

Organize ES header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize SB header files

a10d382

Organize SB header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize TBL header files

92d6d06

Organize TBL header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize TIME header files

935fc45

Organize TIME header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize EVS header files

93e81e6

Organize EVS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize FS header files

a37c0fd

Organize FS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_API header files

5a0981d

Organize CORE_API header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_PRIVATE header files

e69b79c

Organize CORE_PRIVATE header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, clean up sample_defs to match

cbab231

jphickey mentioned this issue

Fix #2320, reorganize headers #2321

Merged

2 tasks

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize ES header files

62ca949

Organize ES header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize SB header files

f7817b7

Organize SB header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize TBL header files

Organize TBL header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize TIME header files

f9c6de9

Organize TIME header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize EVS header files

9c9d37d

Organize EVS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize FS header files

52ad186

Organize FS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_API header files

3a4c253

Organize CORE_API header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_PRIVATE header files

9d6d18c

Organize CORE_PRIVATE header file contents according to the convention

jphickey pushed a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CFE_TESTCASE header files

d706d87

Organize CFE_TESTCASE header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, clean up sample_defs to match

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize EVS header files

3273e29

Organize EVS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize FS header files

69fdafd

Organize FS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_API header files

76c9b43

Organize CORE_API header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_PRIVATE header files

fedb822

Organize CORE_PRIVATE header file contents according to the convention

jphickey pushed a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CFE_TESTCASE header files

591725e

Organize CFE_TESTCASE header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, clean up sample_defs to match

06c4bea

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize SB header files

941468d

Organize SB header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize TBL header files

4c79b5f

Organize TBL header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize TIME header files

d5e2d89

Organize TIME header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize EVS header files

d92d5b9

Organize EVS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize FS header files

134b9d7

Organize FS header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_API header files

ef4d359

Organize CORE_API header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CORE_PRIVATE header files

f0edf1f

Organize CORE_PRIVATE header file contents according to the convention

jphickey pushed a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CFE_TESTCASE header files

ccfb9aa

Organize CFE_TESTCASE header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, adjust scripts and docs for header renames

eea6877

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 added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, reorganize CFE_TESTCASE header files

2db14ee

Organize CFE_TESTCASE header file contents according to the convention

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, adjust scripts and docs for header renames

4bff797

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.

dzbaker added a commit that referenced this issue


          Merge pull request #2321 from jphickey/fix-2320-reorganize-headers

97452ab

Fix #2320, reorganize headers

dzbaker mentioned this issue

cFE Integration candidate: Caelum-rc4+dev49 #2325

Merged

2 tasks

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, do not assume cfe_test is present

e89f426

This is an optional component and thus may not be part of the build.
Hotfix based on workflow testing.

jphickey added a commit to jphickey/cFE that referenced this issue


          Fix nasa#2320, do not assume cfe_test is present

ca5106f

This is an optional component and thus may not be part of the build.
Hotfix based on workflow testing.

dzbaker added a commit that referenced this issue


          Merge pull request #2321 from jphickey/fix-2320-reorganize-headers

00ff6da

Fix #2320, reorganize headers

dzbaker closed this as completed in

c9095c0

dmknutsen added this to the Equuleus milestone

dmknutsen added the Equuleus-rc1 label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment