You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
As CFS apps are under development for the next cycle it should be a goal to reduce all the variation in terminology between them. This includes, but not limited to:
Event naming patterns
Command naming patterns (specifically between the function that handles the command, the structure that defines the command)
The first step in fixing pattern violations is to better define the intended pattern. This should be done as part of the CFE documentation and we can go from there.
Describe the solution you'd like
Consistency in naming, repeatable patterns.
Additional context
Examples of what NOT to do were recently addressed in nasa/FM#131, specifically stuff like:
Send HK command: command handler was FM_ReportHK(), the command struct name was FM_HousekeepingCmd, and the MID was FM_SEND_HK_MID. Why are these all different - Should all be FM_SendHkCmd (Camel Case version).
For FM_SET_FILE_PERM_CC the command handler was named FM_SetPermissionsCmd - no "file" - and the struct was named FM_SetPermCmd_t - "permissions" got abbreviated.
Other examples of abbreviation mismatch between Dir and Directory exist, and the word File/Files appears in command names in some places but not other places.
Similar naming chaos occurs in other CFS apps too, FM just provided some good examples of what not to do.
Requester Info
Joseph Hickey, Vantage Systems, Inc.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
As CFS apps are under development for the next cycle it should be a goal to reduce all the variation in terminology between them. This includes, but not limited to:
The first step in fixing pattern violations is to better define the intended pattern. This should be done as part of the CFE documentation and we can go from there.
Describe the solution you'd like
Consistency in naming, repeatable patterns.
Additional context
Examples of what NOT to do were recently addressed in nasa/FM#131, specifically stuff like:
Send HK command: command handler was
FM_ReportHK()
, the command struct name wasFM_HousekeepingCmd
, and the MID wasFM_SEND_HK_MID
. Why are these all different - Should all beFM_SendHkCmd
(Camel Case version).For
FM_SET_FILE_PERM_CC
the command handler was namedFM_SetPermissionsCmd
- no "file" - and the struct was namedFM_SetPermCmd_t
- "permissions" got abbreviated.Other examples of abbreviation mismatch between
Dir
andDirectory
exist, and the wordFile
/Files
appears in command names in some places but not other places.Similar naming chaos occurs in other CFS apps too, FM just provided some good examples of what not to do.
Requester Info
Joseph Hickey, Vantage Systems, Inc.
The text was updated successfully, but these errors were encountered: