From 4fde4a8d0adfb302cd9915f5b21010bf1662c834 Mon Sep 17 00:00:00 2001 From: gomonovych Date: Tue, 2 Mar 2021 02:10:00 +0100 Subject: [PATCH] Add description for vTaskList (#206) Describe each column which vTaskList print: task name, task status, task priority, task stack unused watermark lewel, task number Co-authored-by: David Chalco <59750547+dachalco@users.noreply.github.com> --- include/task.h | 6 ++++-- tasks.c | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/include/task.h b/include/task.h index d2d1a1901..181ed70fd 100644 --- a/include/task.h +++ b/include/task.h @@ -1795,8 +1795,10 @@ UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray, * demo applications. Do not consider it to be part of the scheduler. * * vTaskList() calls uxTaskGetSystemState(), then formats part of the - * uxTaskGetSystemState() output into a human readable table that displays task - * names, states and stack usage. + * uxTaskGetSystemState() output into a human readable table that displays task: + * names, states, priority, stack usage and task number. + * Stack usage specified as the number of unused StackType_t words stack can hold + * on top of stack - not the number of bytes. * * vTaskList() has a dependency on the sprintf() C library function that might * bloat the code size, use a lot of stack, and provide different results on diff --git a/tasks.c b/tasks.c index 6ba21bbd3..a994ec908 100644 --- a/tasks.c +++ b/tasks.c @@ -4434,7 +4434,9 @@ static void prvResetNextTaskUnblockTime( void ) * * vTaskList() calls uxTaskGetSystemState(), then formats part of the * uxTaskGetSystemState() output into a human readable table that - * displays task names, states and stack usage. + * displays task: names, states, priority, stack usage and task number. + * Stack usage specified as the number of unused StackType_t words stack can hold + * on top of stack - not the number of bytes. * * vTaskList() has a dependency on the sprintf() C library function that * might bloat the code size, use a lot of stack, and provide different