Skip to content

Commit 4e4ef0e

Browse files
committed
Code review suggestions
Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>
1 parent 79a66c6 commit 4e4ef0e

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

include/task.h

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2199,24 +2199,25 @@ 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 running ('X'), blocked ('B'), ready ('R'), deleted ('D') or
2203-
* suspended ('S').
2204-
*
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
2202+
* Tasks are reported as running ('X'), blocked ('B'), ready ('R'), deleted ('D')
2203+
* or suspended ('S').
22112204
*
22122205
* PLEASE NOTE:
22132206
*
22142207
* This function is provided for convenience only, and is used by many of the
22152208
* demo applications. Do not consider it to be part of the scheduler.
22162209
*
22172210
* vTaskListTasks() calls uxTaskGetSystemState(), then formats part of the
2218-
* uxTaskGetSystemState() output into a human readable table that displays task:
2219-
* names, states, priority, stack usage and task number.
2211+
* uxTaskGetSystemState() output into a human readable table that displays task
2212+
* information in the following format:
2213+
* Task Name, Task State, Task Priority, Task Stack High Watermak, Task Number.
2214+
*
2215+
* The following is a sample output:
2216+
* Task A X 2 67 2
2217+
* Task B R 1 67 3
2218+
* IDLE R 0 67 5
2219+
* Tmr Svc B 6 137 6
2220+
*
22202221
* Stack usage specified as the number of unused StackType_t words stack can hold
22212222
* on top of stack - not the number of bytes.
22222223
*
@@ -2267,17 +2268,25 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
22672268
* Lists all the current tasks, along with their current state and stack
22682269
* usage high water mark.
22692270
*
2270-
* Tasks are reported as blocked ('B'), ready ('R'), deleted ('D') or
2271-
* suspended ('S').
2271+
* Tasks are reported as running ('X'), blocked ('B'), ready ('R'), deleted ('D')
2272+
* or suspended ('S').
22722273
*
22732274
* PLEASE NOTE:
22742275
*
22752276
* This function is provided for convenience only, and is used by many of the
22762277
* demo applications. Do not consider it to be part of the scheduler.
22772278
*
22782279
* vTaskList() calls uxTaskGetSystemState(), then formats part of the
2279-
* uxTaskGetSystemState() output into a human readable table that displays task:
2280-
* names, states, priority, stack usage and task number.
2280+
* uxTaskGetSystemState() output into a human readable table that displays task
2281+
* information in the following format:
2282+
* Task Name, Task State, Task Priority, Task Stack High Watermak, Task Number.
2283+
*
2284+
* The following is a sample output:
2285+
* Task A X 2 67 2
2286+
* Task B R 1 67 3
2287+
* IDLE R 0 67 5
2288+
* Tmr Svc B 6 137 6
2289+
*
22812290
* Stack usage specified as the number of unused StackType_t words stack can hold
22822291
* on top of stack - not the number of bytes.
22832292
*

0 commit comments

Comments
 (0)