-
Notifications
You must be signed in to change notification settings - Fork 198
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
CFE_ES_PerfLogAdd should document config #2407
Labels
docs
This change only affects documentation.
Comments
irowebbn
added a commit
to irowebbn/cFE
that referenced
this issue
Jul 21, 2023
2 tasks
dzbaker
added a commit
that referenced
this issue
Dec 5, 2023
Fix #2407 Add perfid limit info to ES docstring
2 tasks
dzbaker
added a commit
that referenced
this issue
Dec 5, 2023
Fix #2407 Add perfid limit info to ES docstring
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
The docstring for CFS_ES_PerfLogAdd makes no mention that the value of
Marker
is limited by the config valueCFE_MISSION_ES_PERF_MAX_IDS
.In my case, I have never altered this limit and was not aware of its existence, so I was surprised when calls to the CFE_ES_PerfLogEntry were failing. The only way to know that this value is used is to check the implementation file at
modules/es/fsw/src/cfe_es_perf.c
or the note under from the documentation ofsample_perfids.h
:This text should also appear in the docstring for
CFE_ES_PerfLogAdd
I also find the documentation for
CFE_MISSION_ES_PERF_MAX_IDS
atmodules/es/config/default_cfe_es_interface_cfg.h
confusing:I find this confusing because although the value does affect the size of the
CFE_ES_HousekeepingTlm_Payload
telemetry message via the filter and trigger mask buffers, the wording does not indicate that this limits the upper value of perfids, not the number of perfids. I could have only a few dozen perfids, but if one had a value greater than or equal to this parameter, it would be rejected.Reporter Info
Isaac Rowe, NASA JSC (Jacobs Technology)
The text was updated successfully, but these errors were encountered: