Skip to content

Commit bbf2d97

Browse files
committed
Add description for vTaskList
Describe each column which vTaskList print: task name, task status, task priority, task stack unused watermark lewel, task number
1 parent aa471cf commit bbf2d97

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

include/task.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1795,8 +1795,10 @@ UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray,
17951795
* demo applications. Do not consider it to be part of the scheduler.
17961796
*
17971797
* vTaskList() calls uxTaskGetSystemState(), then formats part of the
1798-
* uxTaskGetSystemState() output into a human readable table that displays task
1799-
* names, states and stack usage.
1798+
* uxTaskGetSystemState() output into a human readable table that displays task:
1799+
* names, states, priority, stack usage and task number.
1800+
* Stack usage specified as the number of unused StackType_t words stack can hold
1801+
* on top of stack - not the number of bytes.
18001802
*
18011803
* vTaskList() has a dependency on the sprintf() C library function that might
18021804
* bloat the code size, use a lot of stack, and provide different results on

tasks.c

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4434,7 +4434,9 @@ static void prvResetNextTaskUnblockTime( void )
44344434
*
44354435
* vTaskList() calls uxTaskGetSystemState(), then formats part of the
44364436
* uxTaskGetSystemState() output into a human readable table that
4437-
* displays task names, states and stack usage.
4437+
* displays task: names, states, priority, stack usage and task number.
4438+
* Stack usage specified as the number of unused StackType_t words stack can hold
4439+
* on top of stack - not the number of bytes.
44384440
*
44394441
* vTaskList() has a dependency on the sprintf() C library function that
44404442
* might bloat the code size, use a lot of stack, and provide different

0 commit comments

Comments
 (0)