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.

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 headers and structure them according to documented patterns #418

Closed
3 tasks done
jphickey opened this issue Nov 30, 2023 · 0 comments · Fixed by #419
Closed
3 tasks done

Reorganize headers and structure them according to documented patterns #418

jphickey opened this issue Nov 30, 2023 · 0 comments · Fixed by #419
Assignees
@jphickey
Labels
enhancement

Comments

@jphickey
Copy link
Contributor

Checklist (Please check before submitting)

  • I reviewed the Contributing Guide.
  • I reviewed the README file to see if the feature is in the major future work.
  • I performed a cursory search to see if the feature request is relevant, not redundant, nor in conflict with other tickets.

Is your feature request related to a problem? Please describe.
Header file names need to be adjusted to match the convention described in nasa/cFE#2306. Message definitions and command handler functions also do not currently adhere to the CFS patterns.

  • Messages should have a separate "Payload" definition
  • All commands should have a dedicated type and command handler with the same name that accepts a const arg of the corresponding msg type.

Describe the solution you'd like
Rename the files, restructure the messages

Additional context
Improving consistency between CFS apps for file names and content.

None of this should affect backward compatibility; the external message definitions shouldn't change.

Requester Info
Joseph Hickey, Vantage Systems, Inc.
@jphickey jphickey self-assigned this Nov 30, 2023
jphickey added a commit to jphickey/CF that referenced this issue Nov 30, 2023
@jphickey
Fix nasa#418, reorganize header files and restructure messages
9767001 
Move the header files to a "config" directory as documented in the CFE
guidelines, which allows easier override.

Organize the content to adhere to the patterns.

Specifically - adds a dedicated structure type for each cmd, and also
puts the payload into a separate sub-structure.

Command handlers and tests updated accordingly (many of which were simplified).
@jphickey jphickey mentioned this issue Nov 30, 2023
Merged
2 tasks
jphickey added a commit to jphickey/CF that referenced this issue Nov 30, 2023
@jphickey
Fix nasa#418, reorganize header files and restructure messages
f48afab 
Move the header files to a "config" directory as documented in the CFE
guidelines, which allows easier override.

Organize the content to adhere to the patterns.

Specifically - adds a dedicated structure type for each cmd, and also
puts the payload into a separate sub-structure.

Command handlers and tests updated accordingly (many of which were simplified).
jphickey added a commit to jphickey/CF that referenced this issue Nov 30, 2023
@jphickey
Fix nasa#418, reorganize header files and restructure messages
adff380 
Move the header files to a "config" directory as documented in the CFE
guidelines, which allows easier override.

Organize the content to adhere to the patterns.

Specifically - adds a dedicated structure type for each cmd, and also
puts the payload into a separate sub-structure.

Command handlers and tests updated accordingly (many of which were simplified).
jphickey added a commit to jphickey/CF that referenced this issue Nov 30, 2023
@jphickey
Fix nasa#418, reorganize header files and restructure messages
5b6fc9a 
Move the header files to a "config" directory as documented in the CFE
guidelines, which allows easier override.

Organize the content to adhere to the patterns.

Specifically - adds a dedicated structure type for each cmd, and also
puts the payload into a separate sub-structure.

Command handlers and tests updated accordingly (many of which were simplified).
jphickey added a commit to jphickey/CF that referenced this issue Nov 30, 2023
@jphickey
Fix nasa#418, reorganize header files and restructure messages
323ff05 
Move the header files to a "config" directory as documented in the CFE
guidelines, which allows easier override.

Organize the content to adhere to the patterns.

Specifically - adds a dedicated structure type for each cmd, and also
puts the payload into a separate sub-structure.

Command handlers and tests updated accordingly (many of which were simplified).
dzbaker added a commit that referenced this issue Dec 5, 2023
@dzbaker
Merge pull request #419 from jphickey/fix-418-header-reorg
515e3a8 
Fix #418, reorganize header files and restructure messages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jphickey jphickey

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix #418, reorganize header files and restructure messages jphickey/CF
1 participant
@jphickey