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>
This commit is contained in:
gomonovych 2021-03-02 02:10:00 +01:00 committed by GitHub
parent 2a604f4a28
commit 4fde4a8d0a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 3 deletions

View file

@ -1795,8 +1795,10 @@ UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray,
* demo applications. Do not consider it to be part of the scheduler. * demo applications. Do not consider it to be part of the scheduler.
* *
* vTaskList() calls uxTaskGetSystemState(), then formats part of the * vTaskList() calls uxTaskGetSystemState(), then formats part of the
* uxTaskGetSystemState() output into a human readable table that displays task * uxTaskGetSystemState() output into a human readable table that displays task:
* names, states and stack usage. * 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 * 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 * bloat the code size, use a lot of stack, and provide different results on

View file

@ -4434,7 +4434,9 @@ static void prvResetNextTaskUnblockTime( void )
* *
* vTaskList() calls uxTaskGetSystemState(), then formats part of the * vTaskList() calls uxTaskGetSystemState(), then formats part of the
* uxTaskGetSystemState() output into a human readable table that * 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 * vTaskList() has a dependency on the sprintf() C library function that
* might bloat the code size, use a lot of stack, and provide different * might bloat the code size, use a lot of stack, and provide different