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

Consistent naming in SAMPLE APP #40

Closed
jphickey opened this issue Feb 11, 2020 · 0 comments · Fixed by #43 or #47
Closed

Consistent naming in SAMPLE APP #40

jphickey opened this issue Feb 11, 2020 · 0 comments · Fixed by #43 or #47
Milestone
Bootes

Comments

@jphickey
Copy link
Contributor

jphickey commented Feb 11, 2020 •
edited
Loading

Is your feature request related to a problem? Please describe.
To adhere to the patterns established in other modules, the SAMPLE app should employ a consistent pattern to its local variables and functions. There is currently a mixture of different styles.

Describe the solution you'd like

  • All global scope items should start with SAMPLE_ (not Sample_ or otherwise)
  • All runtime data should be inside a global struct (already is for the most part)
  • Members of the global struct do NOT use the SAMPLE_ prefix (name is already qualified/namespace protected).
  • Command handling functions should match the name of the command

Requester Info
Joseph Hickey, Vantage Systems, Inc.
@jphickey jphickey mentioned this issue Feb 11, 2020
Merged
jphickey added a commit to jphickey/sample_app that referenced this issue Mar 2, 2020
@jphickey
Fix nasa#40: Apply consistent naming conventions
4a4b6e5 
Update SAMPLE to better correlate with the naming conventions used
elsewhere and documented in the CFE naming conventions

- Put all global runtime data into a single "SAMPLE_AppData" object
- Name all global-scope identifiers consistently with a "SAMPLE_" prefix
- Do not use SAMPLE prefix for members already inside global
- Command handlers named to match the command they process
- Command handlers return an int32 status value
- Telemetry payload defined in a separate structure
- Member names in telemetry struct following convention in the
  CFE naming convention document.
astrogeco pushed a commit that referenced this issue Mar 9, 2020
@jphickey @astrogeco
Fix #40: Apply consistent naming conventions
4adabae 
Update SAMPLE to better correlate with the naming conventions used
elsewhere and documented in the CFE naming conventions

- Put all global runtime data into a single "SAMPLE_AppData" object
- Name all global-scope identifiers consistently with a "SAMPLE_" prefix
- Do not use SAMPLE prefix for members already inside global
- Command handlers named to match the command they process
- Command handlers return an int32 status value
- Telemetry payload defined in a separate structure
- Member names in telemetry struct following convention in the
  CFE naming convention document.
@astrogeco astrogeco mentioned this issue Mar 10, 2020
Merged
@astrogeco astrogeco linked a pull request Mar 10, 2020 that will close this issue
IC 20200304 #47
Merged
@astrogeco astrogeco added this to the 1.2.0 milestone Oct 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Bootes
Development

Successfully merging a pull request may close this issue.

General SAMPLE App cleanup jphickey/sample_app
IC 20200304 nasa/sample_app
2 participants
@jphickey @astrogeco