Skip to content

Commit 69e1b7c

Browse files
authored
Clarify documentation of xTaskNumber in TaskStatus_t. (FreeRTOS#1081)
Discussed here: https://forums.freertos.org/t/tracing-improvements/20097 Adds a note to the (confusingly named) xTaskNumber member of TaskStatus_t explaining that the value is different to the TaskNumber that can be accessed using the vTaskSetTaskNumber and vTaskGetTaskNumber functions. The value returned is actually the value of uxTCBNumber in the TCB.
1 parent 65e6297 commit 69e1b7c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

include/task.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ typedef struct xTASK_STATUS
161161
{
162162
TaskHandle_t xHandle; /* The handle of the task to which the rest of the information in the structure relates. */
163163
const char * pcTaskName; /* A pointer to the task's name. This value will be invalid if the task was deleted since the structure was populated! */
164-
UBaseType_t xTaskNumber; /* A number unique to the task. */
164+
UBaseType_t xTaskNumber; /* A number unique to the task. Note that this is not the task number that may be modified using vTaskSetTaskNumber() and uxTaskGetTaskNumber(), but a separate TCB-specific and unique identifier automatically assigned on task generation. */
165165
eTaskState eCurrentState; /* The state in which the task existed when the structure was populated. */
166166
UBaseType_t uxCurrentPriority; /* The priority at which the task was running (may be inherited) when the structure was populated. */
167167
UBaseType_t uxBasePriority; /* The priority to which the task will return if the task's current priority has been inherited to avoid unbounded priority inversion when obtaining a mutex. Only valid if configUSE_MUTEXES is defined as 1 in FreeRTOSConfig.h. */

0 commit comments

Comments
 (0)