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

Add description field to all LOG and PARAM variables #148

Closed
tobbeanton opened this issue Sep 19, 2016 · 1 comment
Closed

Add description field to all LOG and PARAM variables #148

tobbeanton opened this issue Sep 19, 2016 · 1 comment

Comments

@tobbeanton
Copy link
Member

As many wonder what the LOG variables and PARAMs really mean I suggest adding a description to them. We could e.g. go the doxygen way or maybe even add that to the macro so it could be fetched from the cfclient and displayed there.

@krichardsson
Copy link
Contributor

One solution would be to add a description as a fourth parameter to the PARAM_ADD and LOG_ADD. We add access to the strings through the memory sub system by adding two new memory types and assign each parameter and log entry a memory area based on its id in the TOC. The address could for instance be chosen as id * 1024 or similar.
This have no impact on performance since the strings are only transferred when needed and it does not breaks current implementations.

@jonasdn jonasdn closed this as completed Aug 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants