]> begriffs open source - freertos/commit
Clarify documentation of xTaskNumber in TaskStatus_t. (#1081)
authorPhilipp Schilk <schilk.philipp@gmail.com>
Thu, 6 Jun 2024 04:53:34 +0000 (06:53 +0200)
committerGitHub <noreply@github.com>
Thu, 6 Jun 2024 04:53:34 +0000 (10:23 +0530)
commit69e1b7c64a09ac9901634b2feac2ab324ec9328f
tree1e95d8b9c60bfec5ffa627f671bfd37c80ae119c
parent65e6297b68aca587eb22b145aee23e479e1af8b3
Clarify documentation of xTaskNumber in TaskStatus_t. (#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.
include/task.h