Skip to content

Commit 79a66c6

Browse files
committed
Add an example of human readable table generated by vTaskListTasks() to task.h
1 parent f31787d commit 79a66c6

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

include/task.h

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2199,9 +2199,16 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
21992199
* Lists all the current tasks, along with their current state and stack
22002200
* usage high water mark.
22012201
*
2202-
* Tasks are reported as blocked ('B'), ready ('R'), deleted ('D') or
2202+
* Tasks are reported as running ('X'), blocked ('B'), ready ('R'), deleted ('D') or
22032203
* suspended ('S').
22042204
*
2205+
* The example of a human readable table generated by vTaskListTasks()
2206+
* Task Name State Priority HighWaterMark Task ID
2207+
* Task A X 2 67 2
2208+
* Task B R 1 67 3
2209+
* IDLE R 0 67 5
2210+
* Tmr Svc B 6 137 6
2211+
*
22052212
* PLEASE NOTE:
22062213
*
22072214
* This function is provided for convenience only, and is used by many of the

0 commit comments

Comments
 (0)