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

Values for TriggerMode provided to CFE_ES_StartPerfCmd are not documented #2410

Closed
irowebbn opened this issue Jul 21, 2023 · 0 comments · Fixed by #2411
Closed

Values for TriggerMode provided to CFE_ES_StartPerfCmd are not documented #2410

irowebbn opened this issue Jul 21, 2023 · 0 comments · Fixed by #2411
Labels
docs This change only affects documentation.

Comments

@irowebbn
Copy link
Contributor

Describe the bug

Here is the documentation for the CFE_ES_StartPerfCmd_Payload struct:

10.39.2.1 TriggerMode uint32 CFE_ES_StartPerfCmd_Payload::TriggerMode
Desired trigger position (Start, Center, End)
Definition at line 279 of file default_cfe_es_msgstruct.h

There is no indication what values correspond with Start, Center, and End.

Some searching reveals that the implementation in modules/es/fsw/src/cfe_es_perf.c compares for values CFE_ES_PERF_TRIGGER_{START,CENTER,END}. The public header /modules/es/fsw/src/cfe_es_perf.h has the enum values for this, but there is no docstring and therefore does not appear in the user guide. The actual default numeric values would be good to indicate somewhere because the commanding interface may not have access to the CFE_ES_PERF_TRIGGER* macros, ie, when using cmdUtil from the command line.

Reporter Info
Isaac Rowe, NASA JSC, Jacobs Technology

@chillfig chillfig added the docs This change only affects documentation. label Aug 30, 2023
irowebbn added a commit to irowebbn/cFE that referenced this issue Dec 5, 2023
irowebbn added a commit to irowebbn/cFE that referenced this issue Dec 5, 2023
dzbaker added a commit that referenced this issue Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change only affects documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants