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

[Feature Request] Add titles for each column of "vTaskListTasks" #1213

Closed
wwhheerree opened this issue Dec 23, 2024 · 4 comments
Closed

[Feature Request] Add titles for each column of "vTaskListTasks" #1213

wwhheerree opened this issue Dec 23, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@wwhheerree
Copy link
Contributor

wwhheerree commented Dec 23, 2024

Is your feature request related to a problem? Please describe.
When I use "vTaskListTasks" and print out current task report, there is no title for each column.
For new beginners, they have to refer to FreeRTOS document for detailed decriptions of each column.
image

Describe the solution you'd like
I think adding a title for each column will be better for human readability.
image

I have created a PR if you think this enhancement is helpful.
#1214

@aggarg
Copy link
Member

aggarg commented Dec 23, 2024

While this is a good suggestion, it may break existing applications using this API as it increases the required buffer size. Additionally, you can print this line in application if you want. How about adding this information in the function documentation - https://github.com/FreeRTOS/FreeRTOS-Kernel/blob/main/include/task.h#L2186?

@aggarg
Copy link
Member

aggarg commented Dec 24, 2024

Yes, that sounds good. Please raise a PR.

@wwhheerree
Copy link
Contributor Author

PR has been submitted.
#1215

@aggarg
Copy link
Member

aggarg commented Dec 24, 2024

I have merged the PR #1215. Thank you for your contribution!

@aggarg aggarg closed this as completed Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants